GetByteValue Method

Summary

Gets an array of byte values that is stored in the Value Field of the specified element.

Syntax

C++

Java

public byte[] GetByteValue(  
   DicomElement element, 
   int index, 
   int count 
)

Public Overloads Function GetByteValue( _ 
   ByVal element As DicomElement, _ 
   ByVal index As Integer, _ 
   ByVal count As Integer _ 
) As Byte()

public byte[] getByteValue(DicomElement element, int index, int count)

public: 
array<byte>^ GetByteValue(  
   DicomElement^ element, 
   int index, 
   int count 
)

Parameters

element
An item in the Data Set.

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

count
Value that represents 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 equal to one.

Return Value

A buffer that contains byte values from the Value Field of the specified Data Element, or an empty buffer 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

If you have more than one value stored in the Value Field of the specified Data Element, you can retrieve one or more than one of those elements. For example, if the Value Field of the specified Data Element contains three byte values, and you are only interested in retrieving the last two byte values, set index to 1 and count to 2. This tells the method to retrieve the byte 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 method can be called only if the Value Representation of the Data Element is DicomVRType.OB, DicomVRType.SQ, or DicomVRType.UN. For more information about Value Representations, refer to Default Value Representation Table.

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms