Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.10.31
SetStringValuePtr Method
See Also 
Leadtools.Dicom Namespace > DicomDataSet Class : SetStringValuePtr Method




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.
characterSet
Character set to use when inserting the input string.
Sets the string value(s) of a Data Element.

Syntax

Visual Basic (Declaration) 
Public Function SetStringValuePtr( _
   ByVal element As DicomElement, _
   ByVal value As IntPtr, _
   ByVal count As Integer, _
   ByVal characterSet As DicomCharacterSetType _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As DicomDataSet
Dim element As DicomElement
Dim value As IntPtr
Dim count As Integer
Dim characterSet As DicomCharacterSetType
Dim value As Boolean
 
value = instance.SetStringValuePtr(element, value, count, characterSet)
C# 
public bool SetStringValuePtr( 
   DicomElement element,
   IntPtr value,
   int count,
   DicomCharacterSetType characterSet
)
Managed Extensions for C++ 
public: bool SetStringValuePtr( 
   DicomElement* element,
   IntPtr value,
   int count,
   DicomCharacterSetType characterSet
) 
C++/CLI 
public:
bool SetStringValuePtr( 
   DicomElement^ element,
   IntPtr value,
   int count,
   DicomCharacterSetType characterSet
) 

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.
characterSet
Character set to use when inserting the input string.

Return Value

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

Example

For an example, refer to SetIntValue.

Remarks

Note: You must 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 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 DicomVRType.AE, DicomVRType.CS, DicomVRType.LO, DicomVRType.LT, DicomVRType.SH, DicomVRType.ST, DicomVRType.UI, DicomVRType.UT, or DicomVRType.PN. 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

See Also

Leadtools.Dicom requires a Medical toolkit license and unlock key. For more information, refer to: Raster Pro/Document/Medical Features