GetStringValue Method

Summary

Gets a string value that is stored in the Value Field of the specified element.

Syntax

C++

Java

public string GetStringValue( 
   DicomElement element, 
   int index 
)

Public Function GetStringValue( _ 
   ByVal element As DicomElement, _ 
   ByVal index As Integer _ 
) As String

public String getStringValue(DicomElement element, int index)

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. It is 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.

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.