L_DicomGetFirstElement

Summary

Returns a pointer to the first item in the Data Set.

Syntax

L_LTDIC_API pDICOMELEMENT L_DicomGetFirstElement(hDS, pElement, bTree, bVolatile)

Parameters

HDICOMDS hDS

A DICOM handle.

pDICOMELEMENT pElement

Pointer to a DICOMELEMENT structure within the Data Set. A pointer to the DICOMELEMENT structure that contains the first item in the Data Set will be returned.

L_BOOL bTree

Flag that indicates how the Data Set will be evaluated. Possible values are:

L_BOOL bVolatile

Flag that indicates the type of element to retrieve. Possible values are:

Returns

Comments

If the Data Set is evaluated as a tree structure, this function returns the first item on the same level as pElement with the same parent as pElement. Please note that the numbering of the items in this first illustration is arbitrary and does not imply order.

If the Data Set is evaluated as a list, the first item in the list is returned. Please note that the numbering of the items in this illustration does indicate the order of the items when the Data Set is evaluated as a list.

The following functions will also help you navigate the Data Set as either a tree or a list:

• L_DicomGetLastElement
• L_DicomGetPrevElement
• L_DicomGetNextElement

If you evaluate the Data Set as a tree, you can also use the following functions to navigate the tree:

• L_DicomGetRootElement
• L_DicomGetParentElement
• L_DicomGetChildElement

A volatile element is an element that can be changed or destroyed in the process of inserting or setting an image. A non-volatile element is an element that must be changed manually. It is not changed or destroyed by inserting or setting an image.

For example, a grayscale image has elements TAG_SMALLEST_IMAGE_PIXEL_VALUE, TAG_LARGEST_IMAGE_PIXEL_VALUE, etc. If the image is changed to a color image, these elements disappear and the following elements appear: TAG_RED_PALETTE_COLOR_LOOKUP_TABLE_DESCRIPTOR, etc. These are volatile elements since they are changed or destroyed when an image is changed or set.

To retrieve the first element that must be changed manually, i.e. is not volatile, set bVolatile to FALSE. To retrieve the first element, either volatile or non-volatile, set bVolatile to TRUE.

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.

See Also

Functions

• L_DicomGetLastElement
• L_DicomGetPrevElement
• L_DicomGetNextElement
• L_DicomGetCountModule
• L_DicomGetRootElement
• L_DicomGetParentElement
• L_DicomGetChildElement
• L_DicomIsVolatileElement

Topics

• Working with Data Sets

Example

This example displays in a tree control the list of elements in the Data Set

L_VOID ShowList(HWND hDlg, HDICOMDS hDS) 
{ 
   TV_INSERTSTRUCT tvInsert; 
   TV_ITEM         tvItem; 
   HTREEITEM       hItem; 
   pDICOMELEMENT   pElement; 
   pDICOMTAG       pTag; 
   L_TCHAR          szUnknown[]=TEXT("Unknown"); 
   L_TCHAR         *p; 
 
   pElement = L_DicomGetFirstElement(hDS, NULL, FALSE, FALSE); 
 
   while (pElement != NULL) 
   { 
      pTag = L_DicomFindTag(pElement->nTag); 
      if (pTag != NULL) 
      { 
         p = pTag->pszName; 
      } 
      else 
      { 
         p = szUnknown; 
      } 
 
      tvItem.mask           = TVIF_TEXT; 
      tvItem.pszText        = p; 
      tvInsert.hParent      = TVI_ROOT; 
      tvInsert.hInsertAfter = TVI_LAST; 
      tvInsert.item         = tvItem; 
 
      hItem = (HTREEITEM)SendMessage(hDlg, TVM_INSERTITEM, (WPARAM)0,  
                                     (LPARAM)(LPTV_INSERTSTRUCT)&tvInsert); 
 
      pElement = L_DicomGetNextElement(hDS, pElement, FALSE, FALSE); 
   } 
} 
 
L_INT DicomGetFirstElementExample(HWND hDlg) 
{ 
   HDICOMDS hDS; 
 
   hDS = L_DicomCreateDS(NULL); 
   L_DicomInitDS(hDS, CLASS_XA_BIPLANE_IMAGE_STORAGE_RETIRED, 0);  
   ShowList(hDlg, hDS); 
   L_DicomFreeDS(hDS); 
 
   return DICOM_SUCCESS; 
}