GetTimeRangeValue Method

Summary

Gets a DicomTimeRangeValue structure that contains time range information for the specified element.

Syntax

C++

Java

public DicomTimeRangeValue GetTimeRangeValue( 
   DicomElement element, 
   int index 
)

Public Function GetTimeRangeValue( _ 
   ByVal element As DicomElement, _ 
   ByVal index As Integer _ 
) As DicomTimeRangeValue

public DicomTimeRangeValue getTimeRangeValue(DicomElement element, int index)

public: 
DicomTimeRangeValue GetTimeRangeValue(  
   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 DicomTimeRangeValue that contains time range information for the specified element. This method returns an empty DicomTimeRangeValue 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.TM. For more information about Value Representations, refer to Default Value Representation Table.

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms