LDicomDS::GetFirstKey

Summary

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

Syntax

pDICOMELEMENT LDicomDS::GetFirstKey(pElement, bTree)

Parameters

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:

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.

NOTE: 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.

NOTE: 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:

LDicomDS::GetLastKey

LDicomDS::GetPrevKey

LDicomDS::GetNextKey

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

Platforms

Win32, x64

See Also

Functions

• LDicomDS::GetLastKey
• LDicomDS::GetPrevKey
• LDicomDS::GetNextKey
• 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.