L_DicomSetStringValue

#include "Ltdic.h"

L_LTDIC_API L_BOOL L_DicomSetStringValue(hDS, pElement, pValue, nCount, uCharacterSet)

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

Parameters

HDICOMDS hDS

A DICOM handle.

pDICOMELEMENT pElement

Pointer to a DICOMELEMENT structure within the Data Set.

L_TCHAR * pValue

Pointer to a or character string 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 string and set nCount to the appropriate number of values.

L_UINT32 nCount

Value that indicates 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 pValue and set nCount to the appropriate number.

L_UINT32 uCharacterSet

Character set to use when inserting the input string. Possible values are:

Value Meaning
DICOM_CHARACTER_SET_DEFAULT Default repertoire (the default repertoire for character strings in DICOM), better known as ASCII
DICOM_CHARACTER_SET_LATIN_ALPHABET_NO_1 Latin alphabet No. 1
DICOM_CHARACTER_SET_LATIN_ALPHABET_NO_2 Latin alphabet No. 2
DICOM_CHARACTER_SET_LATIN_ALPHABET_NO_3 Latin alphabet No. 3
DICOM_CHARACTER_SET_LATIN_ALPHABET_NO_4 Latin alphabet No. 4
DICOM_CHARACTER_SET_CYRILLIC Cyrillic
DICOM_CHARACTER_SET_ARABIC Arabic
DICOM_CHARACTER_SET_GREEK Greek
DICOM_CHARACTER_SET_HEBREW Hebrew
DICOM_CHARACTER_SET_LATIN_ALPHABET_NO_5 Latin alphabet No. 5
DICOM_CHARACTER_SET_JAPANESE_JIS_X_0201 Japanese
DICOM_CHARACTER_SET_THAI Thai
DICOM_CHARACTER_SET_KOREAN Korean
DICOM_CHARACTER_SET_UNICODE_IN_UTF8 Unicode in UTF-8
DICOM_CHARACTER_SET_GB18030 GB18030

Returns

Value Meaning
TRUE The string value(s) were set successfully.
FALSE Could not set the string value(s) of the Data Element.

Comments

To set the string value(s) of a Data Element using default DICOM character set (DICOM_CHARACTER_SET_DEFAULT), use L_DicomSetStringValue2.

Note: You must allocate the memory for pValue.

If you want to set more than one value in the Value Field of the Data Element, put all the string values in pValue and set nCount 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 pValue, separated by the "0" delimiter and set nCount to three. For example, the illustration below shows a character string, containing three strings separated by the 0 delimiter.

image\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 function can be called only if the Value Representation of the Data Element is VR_AE, VR_CS, VR_LO, VR_LT, VR_SH, VR_ST, VR_UI, VR_UT, or VR_PN. For more information about Value Representations, refer to Default Value Representation Table.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

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

LEADTOOLS DICOM C API Help