LDicomDS::GetNextKey

#include "ltdic.h"

pDICOMELEMENT LDicomDS::GetNextKey(pElement, bTree)

pDICOMELEMENT pElement;

/* pointer to a DICOMELEMENT structure */

L_BOOL bTree;

/* flag that indicates how to evaluate the Data Set */

Returns a pointer to the item in the Dicom Dir Data Set that immediately follows the specified item.

Parameter

Description

pElement

Pointer to a DICOMELEMENT structure that contains an item in the Data Set. A pointer to the item in the Data Set that immediately follows this item will be returned.

bTree

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

 

Value

Meaning

 

TRUE

Evaluate the Data Set as a tree.

 

FALSE

Evaluate the Data Set as a list.

Returns

!NULL

A pointer to a DICOMELEMENT structure that contains the item in the Data Set that immediately follows the item specified in pElement.

NULL

There is not an item following pElement. (pElement is the last item in the Data Set.)

Comments

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

image\GetNxtTr.gif

If the passed pointer points to :

The function returns a pointer to :

Item 1

Item 2

Item 3

Item 4

Item 5

NULL

Item 6

Item 7

If the Data Set is evaluated as a list, the next 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.

image\GetNtLst.gif

If the passed pointer points to :

The function returns a pointer to :

Item 14

Item 15

Item 4

Item 5

Item 8

Item 9

Item 19

Item 20

Item 27

Item 28

Item 30

NULL

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

LDicomDS::GetFirstKey

LDicomDS::GetPrevKey

LDicomDS::GetLastKey

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

LDicomDS::GetRootKey

LDicomDS::GetParentKey

LDicomDS::GetChildKey

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:

LDicomDS::GetFirstKey, LDicomDS::GetPrevKey, LDicomDS::GetLastKey, LDicomDS::GetRootKey, LDicomDS::GetParentKey, LDicomDS::GetChildKey

Topics:

Working with Basic Directory Key Elements

 

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

Example

For an example, refer to LDicomDS::InsertKey.