SetFloatValue(DicomElement,IntPtr,int) Method

Summary

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

Syntax

C++

Java

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

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

public boolean setFloatValue(DicomElement element, float[] floatValue, int count)

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

Parameters

element
An item in the Data Set.

value
Pointer to a float value that contains the float value(s) to set. If you want to set multiple values in the Value Field, put all float 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 float values in value and set count to the appropriate number.

Return Value

true if the float value(s) were set successfully. false if could not set the float 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 float values in an array of float 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 float values in the Value Field of the Data Element, create an array of float values containing the three float 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.FL. For more information about Value Representations, refer to Default Value Representation Table.

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms