LDicomIOD::GetFirst

Summary

Returns a pointer to the first item in the IOD Structure.

Syntax

#include "Ltdic.h"

static pDICOMIOD LDicomIOD::GetFirst(pIOD, bTree)

Parameters

pDICOMIOD pIOD

Pointer to a DICOMIOD structure within the IOD Structure. A pointer to the DICOMIOD structure that contains the first item in the IOD Structure will be returned.

L_BOOL bTree

Flag that indicates how the IOD Structure will be evaluated. Possible values are:

Value Meaning
TRUE Evaluate the IOD Structure as a tree.
FALSE Evaluate the IOD Structure as a list.

Returns

Value Meaning
!NULL A pointer to a DICOMIOD structure that contains the first item in the IOD Structure.
NULL The IOD Structure is empty.

Comments

If the IOD Structure is evaluated as a tree structure, this function returns the first item on the same level as pIOD with the same parent as pIOD.

NOTE: The numbering of the items in this first illustration is arbitrary and does not imply order.

image\GetFstTr.gif
If the passed pointer points to The function returns a pointer to
Item 1 Item 2
Item 3 Item 4
Item 5 Item 5
Item 6 Item 7
NULL Item 2

If the IOD Structure is evaluated as a list, the first item in the list is returned.

NOTE: The numbering of the items in this illustration does indicate the order of the items when the IOD Structure is evaluated as a list.

image\GetFtLst.gif
If the passed pointer points to The function returns a pointer to
NULL Item 1
Item 12 Item 1
Item 14 Item 1
Item 22 Item 1
Item 25 Item 1

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

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

Required DLLs and Libraries

Platforms

Win32, x64

See Also

Functions

Topics

Example

This example displays the list of the IOD table.

L_VOID ShowList() 
{ 
   pDICOMIOD pIOD = LDicomIOD::GetFirst(NULL, FALSE); 
 
   while (pIOD != NULL) 
   { 
      OutputDebugString(pIOD->pszName); 
      OutputDebugString(TEXT("\n")); 
 
      pIOD = LDicomIOD::GetNext(pIOD, TRUE); 
   } 
} 
 
L_INT LDicomIOD_GetFirstExample() 
{ 
   ShowList(); 
   return DICOM_SUCCESS; 
} 

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

LEADTOOLS DICOM C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.