L_DicomInsertVR

#include "Ltdic.h"

L_LTDIC_API pDICOMVR L_DicomInsertVR(nCode, pszName, nLength, nRestrict, nUnitSize)

Inserts a new item in the Value Representation Table.

Parameters

L_UINT16 nCode

Code that indicates the type of value to be stored in the data element. For a list of existing values refer to Value Representation Constants.

L_TCHAR * pszName

Character string that contains the name of the value representation. For examples of Value Representation Names, refer to the Default Value Representation Table.

L_UINT32 nLength

The length of the value to be stored in the data element.

L_UINT16 nRestrict

Restrictions on the length. Possible values are:

L_UINT16 nUnitSize

The size of the smallest item to be stored in the value field of the data element.

Returns

Comments

All items are inserted at the bottom of the table.

To see the default values for the Value Representation Table, refer to the Default Value Representation Table.

When evaluating nLength, you must also consider the values in nRestrict. If nRestrict contains VR_FIXED, then nLength is a fixed value. Therefore, the data stored in the value Field of a data element would have that length and nLength and nUnitSize would be equal.

If nRestrict contains VR_MAXIMUM, nLength is the maximum length of data that can be stored in the Value Field of a Data Element. In this case, nUnitSize would contain the minimum length of data to be stored in the Value Field of a Data Element.

For example, in the Default Value Representation Table, value representation VR_AE has the following default values:

Therefore, the Value Field of a Data Element that has a Value Representation of VR_AE can store between 1 and 16 bytes of string data.

For more information on the structure of the DICOM file format, refer to An Overview of Dicom or the DICOM Spec.

Required DLLs and Libraries

• LTDIC
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Platforms

Win32, x64, Linux.

L_INT DicomInsertVRExample(L_VOID) 
{ 
   pDICOMVR pTemp = NULL; 
 
   pTemp = L_DicomInsertVR(0x5858, TEXT("New XXX VR"), 16, VR_STRING | VR_MAXIMUM, 1); 
   if (pTemp == NULL) 
      return DICOM_ERROR_MEMORY; 
 
   pTemp = L_DicomInsertVR(0x5959, TEXT("New YYY VR"),  4, VR_TEXT   | VR_FIXED,   1); 
   if (pTemp == NULL) 
      return DICOM_ERROR_MEMORY; 
 
   return DICOM_SUCCESS; 
}