SetShortValue(DicomElement,IntPtr,int) Method

Summary

Sets the short value(s) of a Data Element.

Syntax

C++

Java

public bool SetShortValue( 
   DicomElement element, 
   IntPtr value, 
   int count 
)

Public Overloads Function SetShortValue( _ 
   ByVal element As DicomElement, _ 
   ByVal value As IntPtr, _ 
   ByVal count As Integer _ 
) As Boolean

public boolean setShortValue(DicomElement element, short[] shortValue, int count)

public: 
bool SetShortValue(  
   DicomElement^ element, 
   IntPtr value, 
   int count 
)

Parameters

element
An item in the Data Set.

value
Pointer to a short that contains the short value(s) to set. If you want to set multiple values in the Value Field, put all short values in value and set count to the appropriate number of values.

count
Value that represents the number of values to set in the Value Field. If you want to set multiple values in the Value Field, put all the character values in value and set count to the appropriate number.

Return Value

true if the short value(s) were set successfully. false if could not set the short value(s) of the Data Element.

Remarks

Note: The user is responsible to allocate the memory for value. If you want to set more than one value in the Value Field of the Data Element, put all the short values in an array of short values, set value to the address of the array, and set count to the corresponding number of entries. For example, if you wish to set three short values in the Value Field of the Data Element, create an array of shorts containing the three short values, set value to the address of the array, and set count to three.

If more than one value is stored in the Value Field of the Data Element, you must set all values at the same time.

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.

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms