GetDateRangeValue Method

Summary

Gets a DicomDateRangeValue structure that contains date range information for the specified element.

Syntax

C++

Java

public DicomDateRangeValue GetDateRangeValue( 
   DicomElement element, 
   int index 
)

Public Function GetDateRangeValue( _ 
   ByVal element As DicomElement, _ 
   ByVal index As Integer _ 
) As DicomDateRangeValue

public DicomDateRangeValue getDateRangeValue(DicomElement element, int index)

public: 
DicomDateRangeValue GetDateRangeValue(  
   DicomElement^ element, 
   int index 
)

Parameters

element
An item in the Data Set.

index
The zero-based index of the value to retrieve, when more than one value is stored in the Value Field.

Return Value

A DicomDateRangeValue that contains date range information for the specified element. This method returns an empty DicomDateRangeValue if the length of the Value Field is 0, the method was called for the incorrect Value Representation type, or the method was called for a folder (sequence) element.

Remarks

This method can be called only if the Value Representation of the Data Element is DicomVRType.DA. For more information about Value Representations, refer to Default Value Representation Table.

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms