LDicomDS::GetRootKey

Show in webframe

#include "ltdic.h"

pDICOMELEMENT LDicomDS::GetRootKey(pElement)

/* pointer to a DICOMELEMENT structure */

Returns a pointer to the root of the specified item.

Parameter	Description
pElement	Pointer to a DICOMELEMENT structure that contains an item in the Data Set.

Returns

!NULL	A pointer to a DICOMELEMENT structure that contains the item in the Data Set that is the root of the item specified in pElement.
NULL	The Data Set is empty or pElement is NULL.

Comments

The root is the Level 0 ancestor of pElement. If pElement points to an item on Level 0, a pointer to that same item will be returned. Please note that the numbering of the items in this illustration is arbitrary and does not imply order.

$image\GetRoot.gif$

If the passed pointer points to :	The function returns a pointer to :
Item 1	Item 2
Item 3	Item 2
Item 4	Item4
Item 5	Item 6

The following functions will also help you navigate the Data Set:

LDicomDS::GetFirstKey

LDicomDS::GetLastKey

LDicomDS::GetNextKey

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