LDicomDS::CreatePrivateCreatorDataElement

#include "Ltdic.h"

L_UINT16 LDicomDS::CreatePrivateCreatorDataElement(pElement, uElementGroup, uElementNumber, pszIdCode, ppPrivateCreatorDataElement)

pDICOMELEMENT pElement;

/* pointer to a DICOMELEMENT structure */

L_UINT16 uElementGroup;

/* group of the private creator data element */

L_UINT16 uElementNumber;

/* element number of the private creator data element */

L_TCHAR * pszIdCode;

/* string used to uniquely identify the element */

pDICOMELEMENT * ppPrivateCreatorDataElement;

/* pointer to the created private creator data element */

Creates a Private Creator Data Element to reserve private data elements. This feature is available in version 16 or higher.

Parameter

Description

pElement

Pointer to a DICOMELEMENT structure that contains an item in the Data Set. The inserted item will be inserted at the same level as this item.

uElementGroup

Group number of the private creator data element.

uElementNumber

Element number of the private creator data element.

pszIdCode

String identifier that is assigned to the private creator data element.

ppPrivateCreatorDataElement

Pointer to the created private creator data element.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

A DICOM Data Set can have private data which is stored in private tags. Private tags are reserved by adding a Private Creator Data Element to the data set. Elements of the form (gggg,0010-00FF) represent private creator data elements. More specifically:

Private Creator Data Elements are elements of the form (gggg,eeee) where

  1. gggg is a four-digit hexadecimal group number

  2. eeee is a four-digit hexadecimal element number

  3. gggg is odd

  4. gggg is NOT 0001, 0003, 0005, 0007 or FFFF

  5. eeee is in the range 0010 to 00FF

  6. Value Represenation is LO (Long String).

  7. Value Multiplicity is 1

A private creator data element of the form (gggg,00ee) reserves the following 256 elements, which can be of any value reprentation:

(gggg, ee00)

(gggg, ee01)

(gggg, ee02)

(gggg, eeFF).

For example, suppose you want to add the following three private elements to a DICOM data set:

(0017,1201)

(0017,1203)

(0017,1205)

You would first reserve the elements by adding the corresponding private creator data element (0017, 0012).

When using LDicomDS::CreatePrivateCreatorDataElement, the created private creator data element is on the same level as the element pointed to by argument pElement. If pElement is NULL, the private creator data element is created at the top or first level.

If parameter uElementNumber is 0xFFFF, the private creator data element is created with the first available element number in group uGroupNumber.

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

See Also

Functions:

LDicomDS::GetNextUnusedPrivateTag, LDicomDS::FindFirstPrivateCreatorDataElement, LDicomDS::FindNextPrivateCreatorDataElement, LDicomDS::FindFirstPrivateElement, LDicomDS::FindNextPrivateElement, Class Members

Topics:

Working with Data Sets

 

Data Sets: Inserting and Deleting Data Set Members

 

How to Disable the Automatic Loading of the default DICOM IOD Table

Example

This example displays all the Private Creator Data Elements and corresponding private elements in a data set. 

#define MSG_BUFFER_SIZE 1000
void DumpElement(TCHAR *pszMsgBox, pDICOMELEMENT p, TCHAR *pszMsg)
{
   if (p == NULL)
      return;
   WCHAR szMsgTemp[100]={0};
   wsprintf(szMsgTemp, L"%s (%.4x,%.4x)\n", pszMsg ? pszMsg : L"", p->nTag >> 0x10, p->nTag & 0xFFFF);
   _tcscat_s(pszMsgBox, MSG_BUFFER_SIZE, szMsgTemp);
}
L_VOID DumpPrivateElements(TCHAR *pszMsgBox, LDicomDS &ds, pDICOMELEMENT pPrivateCreatorDataElement)
{
   pDICOMELEMENT p = ds.FindFirstPrivateElement(pPrivateCreatorDataElement);
   while (p != NULL)
   {
      DumpElement(pszMsgBox, p, L"\t");
      p = ds.FindNextPrivateElement(p, pPrivateCreatorDataElement);
   }
}
L_INT LDicomDS_FindFirstPrivateCreatorDataElementExample(LDicomDS &ds, pDICOMELEMENT pRoot, L_BOOL bTree)
{
   L_INT nRet = DICOM_SUCCESS;
   pDICOMELEMENT pPrivateCreatorDataElement = NULL;
   TCHAR szMsgBox[MSG_BUFFER_SIZE] = {0};
   pPrivateCreatorDataElement = ds.FindFirstPrivateCreatorDataElement(pRoot, bTree, NULL, 0);
   while (pPrivateCreatorDataElement )
   {
      DumpElement(szMsgBox, pPrivateCreatorDataElement, L"*** Private Creator Data Element");
      DumpPrivateElements(szMsgBox, ds, pPrivateCreatorDataElement);
      pPrivateCreatorDataElement = ds.FindNextPrivateCreatorDataElement(pPrivateCreatorDataElement, bTree, NULL, 0);
   }
   MessageBox(NULL, szMsgBox, L"Private Elements", MB_OK);
   return nRet;
}