Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetStringValue Method
See Also 
Leadtools.Dicom Namespace > DicomDataSet Class : GetStringValue Method



element
An item in the Data Set.
index
The zero-based index of the string value to retrieve, when more than one value is stored in the Value Field.
element
An item in the Data Set.
index
The zero-based index of the string value to retrieve, when more than one value is stored in the Value Field.
Returns a string value, stored in the Value Field, of the specified element.

Syntax

Visual Basic (Declaration) 
Public Function GetStringValue( _
   ByVal element As DicomElement, _
   ByVal index As Integer _
) As String
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim element As DicomElement
Dim index As Integer
Dim value As String
 
value = instance.GetStringValue(element, index)
C# 
public string GetStringValue( 
   DicomElement element,
   int index
)
C++/CLI 
public:
String^ GetStringValue( 
   DicomElement^ element,
   int index
)

Parameters

element
An item in the Data Set.
index
The zero-based index of the string value to retrieve, when more than one value is stored in the Value Field.

Return Value

A string value stored in the Value Field of the specified Data Element. null if The length of the Value Field is 0, the method was called for the incorrect VR type, or the method was called for a folder (sequence) element.

Example

Remarks

The method can be used to get one string value at a time. Therefore, if multiple values are stored in the Value Field, the method needs to be called multiple times to get all the values. This method can be called only if the Value Representation of the Data Element is DicomVRType.AE, DicomVRType.CS, DicomVRType.LO, DicomVRType.LT, DicomVRType.SH, DicomVRType.ST, DicomVRType.UI, DicomVRType.UT, or DicomVRType.PN. For more information about Value Representations, refer to Default Value Representation Table.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features