←Select platform

SetStringValuePtr(DicomElement,IntPtr,int,DicomCharacterSetType) Method

Summary

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

Syntax
C#
VB
C++
public bool SetStringValuePtr( 
   DicomElement element, 
   IntPtr value, 
   int count, 
   DicomCharacterSetType characterSet 
) 
Public Overloads Function SetStringValuePtr( _ 
   ByVal element As DicomElement, _ 
   ByVal value As IntPtr, _ 
   ByVal count As Integer, _ 
   ByVal characterSet As DicomCharacterSetType _ 
) As Boolean 
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.

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.

string.gif

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.

Example

For an example, refer to SetStringValue

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom Assembly