SetStringValuePtr(DicomElement,IntPtr,Int32) Method

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

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

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

'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim value As IntPtr
Dim count As Integer
Dim value As Boolean
 
value = instance.SetStringValuePtr(element, value, count)

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

 function Leadtools.Dicom.DicomDataSet.SetStringValuePtr(DicomElement,IntPtr,Int32)( 
   element ,
   value ,
   count 
)

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

Parameters

element: An item in the Data Set.
value: Pointer to buffer that contains the string value(s) to set. If you want to set multiple values in the Value Field, put all string values in this buffer 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 string values in value and set count to the appropriate number.

Return Value

true if The string value(s) were set successfully. false if Could not set the string value(s) of the Data Element.

Note: You must allocate the memory for value.

This overload of SetStringValuePtr(DicomElement,IntPtr,Int32) differs from other versions (SetStringValuePtr(DicomElement,IntPtr,Int32,DicomCharacterSetType)) in that it is missing the last argument (DicomCharacterSetType). This overload is affected by the value(s) in the Specific Character Set (0008,0005) Attribute.

The following DICOM Value Representations are affected by Attribute Specific Character Set (0008,0005)

SH (Short String)
LO (Long String)
ST (Short Text)
LT (Long Text)
UT (Unlimited Text)
PN (Person Name)

If element is one of these Value Representations and the string cannot be represented using the standard character set (ASCII characters), then this overload attempts to encode the string using one or character sets stored in the Specific Character Set Attribute (0008,0005). Before calling this method with unicode strings, make sure that the Specific Character Set Attribute of the DicomDataSet contains values for any character set that is necessary. For example, when encoding a japanese string the the following are some of the possible values for specific character:

"ISO_IR 192" (Unicode in UTF-8)
"ISO_IR 13" (Japanese, single-byte, no code extensions)
"\ISO 2022 IR 87" (Default, JIS X 0208)
"ISO 2022 IR 13\ISO 2022 IR 87" (JIS X 0201, JIS X 0208)

For more information, see Part 3 section 'C.12.1.1.2 Specific Character Set' of the DICOM Specification.

If you want to set more than one value in the Value Field of the Data Element, put all the string values in value and set count to the corresponding number of entries. For example, if you wish to set three string values in the Value Field of the Data Element, put all three strings in value, separated by the "0" delimiter and set count to three. For example, the illustration below shows a character string, containing three strings separated by the 0 delimiter.

For more information on required delimiters between multiple values, refer to An Overview of the DICOM File Format and the DICOM Standard.

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:

For more information about Value Representations, refer to Default Value Representation Table.

For an example, refer to SetStringValue(DicomElement,String,DicomCharacterSetType)

Target Platforms

Reference

DicomDataSet Class
DicomDataSet Members
Overload List
SetValue Method
SetStringValue(DicomElement,String,DicomCharacterSetType) Method
SetStringValue(DicomElement,String[],DicomCharacterSetType) Method
SetStringValue(DicomElement,String) Method
SetStringValue(DicomElement,String[]) Method
SetStringValuePtr(DicomElement,IntPtr,Int32) Method
SetStringValuePtr(DicomElement,IntPtr,UInt32,DicomCharacterSetType) Method
SetBinaryValue(DicomElement,Byte[],Int32) Method
SetShortValue(DicomElement,Int16[],Int32) Method
SetIntValue(DicomElement,Int32[],Int32) Method
SetFloatValue(DicomElement,Single[],Int32) Method
SetDoubleValue(DicomElement,Double[],Int32) Method
SetAgeValue Method
SetDateValue(DicomElement,DicomDateValue[]) Method
SetTimeValue(DicomElement,DicomTimeValue[]) Method
SetDateTimeValue(DicomElement,DicomDateTimeValue[]) Method