LDicomIOD::GetFirst
#include "Ltdic.h"
static pDICOMIOD LDicomIOD::GetFirst(pIOD, bTree)
pDICOMIOD pIOD; |
/* pointer to a DICOMIOD structure */ |
L_BOOL bTree; |
/* flag that indicates how to evaluate the IOD Structure */ |
Returns a pointer to the first item in the IOD Structure.
Parameter |
Description | |
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. | |
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
!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. Please note that the numbering of the items in this first illustration is arbitrary and does not imply order.
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. Please note that the numbering of the items in this illustration does indicate the order of the items when the IOD Structure is evaluated as a list.
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
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 |
See Also
Functions: |
LDicomIOD::GetLast, LDicomIOD::GetPrev, LDicomIOD::GetNext, LDicomIOD::GetCountModule, LDicomIOD::GetRoot, LDicomIOD::GetParent, LDicomIOD::GetChild |
Topics: |
Example
This example displays in a tree control the list of the IOD table.
L_VOID ShowList(CTreeCtrl *pDlg) { HTREEITEM hItem; pDICOMIOD pIOD; pIOD = LDicomIOD::GetFirst(NULL, FALSE); while (pIOD != NULL) { hItem = pDlg->InsertItem(pIOD->pszName, TVI_ROOT, TVI_LAST); pIOD = LDicomIOD::GetNext(pIOD, FALSE); } } L_INT LDicomIOD_GetFirstExample(CTreeCtrl *pDlg) { ShowList(pDlg); return DICOM_SUCCESS; }