In This Topic ▼

L_DicomGetStringValue

#include "Ltdic.h"

L_LTDIC_API L_TCHAR* L_DicomGetStringValue(hDS, pElement, nIndex, nCount)

Returns a pointer to a string value, stored in the Value Field, of the specified element.

Parameters

pDICOMELEMENT pElement

Pointer to a DICOMELEMENT structure within the Data Set.

L_UINT32 nIndex

Index value that indicates which value to retrieve when more than one value is stored in the Value Field. The index is zero-based.

L_UINT32 nCount

Value that indicates the number of values to retrieve when more than one value is stored in the Value Field. In most instances you will only retrieve one value so this parameter will be one.

Returns

Value	Meaning
!NULL	A pointer to a string value stored in the Value Field of the specified Data Element.
NULL	The length of the Value Field is 0, the function was called for the incorrect VR type, or the function was called for a folder (sequence) element.

Comments

If you have more than one value stored in the Value Field of the specified Data Element, you can retrieve one or more of those elements. For example, if the Value Field of the specified Data Element contains three string values, and you are only interested in retrieving the last two string values, set nIndex to 1 and nCount to 2. This tells the function to retrieve the string values starting at position 1 (the index is zero based) and retrieve two values. Therefore you would retrieve the values in positions 1 and 2 in the Value Field.

This function can be called only if the Value Representation of the Data Element is VR_AE, VR_CS, VR_LO, VR_LT, VR_SH, VR_ST, VR_UI, VR_UT, VR_PN. For more information about Value Representations, refer to Default Value Representation Table.

When more than one string is retrieved, all strings, separated by the 0 delimiter, are in the character string returned by this function. For example, the illustration below shows the returned character string, containing three strings separated by the 0 delimiter.

$image\String.gif$