GetShortValue(DicomElement,Int32,UInt32) Method

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public short[] GetShortValue( 
   DicomElement element,
   int index,
   uint count
)

'Declaration
 
Public Overloads Function GetShortValue( _
   ByVal element As DicomElement, _
   ByVal index As Integer, _
   ByVal count As UInteger _
) As Short()

'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim index As Integer
Dim count As UInteger
Dim value() As Short
 
value = instance.GetShortValue(element, index, count)

public short[] GetShortValue( 
   DicomElement element,
   int index,
   uint count
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.GetShortValue(DicomElement,Int32,UInt32)( 
   element ,
   index ,
   count 
)

public:
array<short>^ GetShortValue( 
   DicomElement^ element,
   int index,
   uint 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 to a short value stored in the Value Field of the specified Data Element. null 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.

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 short values, and you are only interested in retrieving the last two short values, set index to 1 and count to 2. This tells the method to retrieve the short 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.OW, DicomVRType.SS, or DicomVRType.US. For more information about Value Representations, refer to Default Value Representation Table.

For an example, refer to SetIntValue(DicomElement,IntPtr,Int32).

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference