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 )

Managed Extensions for 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

For an example, refer to SetIntValue.

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 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Leadtools.Dicom	Requires Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 15.10.31
GetStringValue Method
See Also