Leadtools.Dicom	Requires Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 15.10.31
GetByteValuePtr Method
See Also

Leadtools.Dicom Namespace > DicomDataSet Class : GetByteValuePtr Method

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.

Returns a pointer to a byte value, stored in the Value Field, of the specified element.

Syntax

Visual Basic (Declaration)
Public Function GetByteValuePtr( _ ByVal element As DicomElement, _ ByVal index As Integer, _ ByVal count As Integer _ ) As IntPtr

Visual Basic (Usage)	Copy Code
`Dim instance As DicomDataSet Dim element As DicomElement Dim index As Integer Dim count As Integer Dim value As IntPtr value = instance.GetByteValuePtr(element, index, count)`

C#
public IntPtr GetByteValuePtr( DicomElement element, int index, int count )

Managed Extensions for C++
public: IntPtr GetByteValuePtr( DicomElement* element, int index, int count )

C++/CLI
public: IntPtr GetByteValuePtr( 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 pointer to a byte value stored in the Value Field of the specified Data Element, or IntPtr.Zero 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.

Example

For an example, refer to SetIntValue.

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family