In This Topic ▼

L_DicomGetDateTimeValue

Summary

Returns a pointer to a VALUEDATETIME structure, that contains date-time information stored in the Value Field of the specified element.

Syntax

#include "Ltdic.h"

L_LTDIC_API pVALUEDATETIME L_DicomGetDateTimeValue(hDS, pElement, nIndex, nCount)

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 VALUEDATETIME structure that contains time information 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 Date-Time values, and you are only interested in retrieving the last two Date-Time values, set nIndex to 1 and nCount to 2. This tells the function to retrieve the Date-Time 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_DT. For more information about Value Representations, refer to Default Value Representation Table.