LEADTOOLS Medical (Leadtools.Dicom assembly)

GetStringValue Method

Show in webframe







An item in the Data Set.
The zero-based index of the string value to retrieve, when more than one value is stored in the Value Field.
Gets a string value that is stored in the Value Field of the specified element.
Syntax
public string GetStringValue( 
   DicomElement element,
   int index
)
'Declaration
 
Public Function GetStringValue( _
   ByVal element As DicomElement, _
   ByVal index As Integer _
) As String
'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim index As Integer
Dim value As String
 
value = instance.GetStringValue(element, index)
public string GetStringValue( 
   DicomElement element,
   int index
)

            
public String getStringValue(DicomElement element, int index)
 function Leadtools.Dicom.DicomDataSet.GetStringValue( 
   element ,
   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.
Example
For an example, refer to SetIntValue(DicomElement,IntPtr,Int32).
Requirements

Target Platforms

See Also

Reference

DicomDataSet Class
DicomDataSet Members
GetValue
GetStringValuePtr Method
GetFloatValuePtr(DicomElement,Int32,Int32) Method
GetDoubleValuePtr(DicomElement,Int32,Int32) Method
GetShortValue(DicomElement,Int32,Int32) Method
GetLongValue(DicomElement,Int32,Int32) Method
GetIntValue(DicomElement,Int32,Int32) Method
GetBinaryValue(DicomElement,Int32) Method
GetByteValue(DicomElement,Int32,Int32) Method
GetAgeValue(DicomElement,Int32,Int32) Method
GetDateValue(DicomElement,Int32,Int32) Method
GetTimeValue(DicomElement,Int32,Int32) Method
GetDateTimeValue(DicomElement,Int32,Int32) Method
GetConvertValue Method

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.

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