GetChildElement Method

Summary

Returns the item in the Data Set that is the first child of the specified item.

Syntax

C++

Java

public DicomElement GetChildElement( 
   DicomElement element, 
   bool includeVolatile 
)

Public Function GetChildElement( _ 
   ByVal element As DicomElement, _ 
   ByVal includeVolatile As Boolean _ 
) As DicomElement

public DicomElement getChildElement(DicomElement element, boolean includeVolatile)

public: 
DicomElement^ GetChildElement(  
   DicomElement^ element, 
   bool includeVolatile 
)

Parameters

element
An item in the Data Set.

includeVolatile
true to retrieve the first child element, volatile or non-volatile; false to retrieve the first non-volatile child element.

Return Value

The item in the Data Set that is the first child of the item specified by element, or a null reference (Nothing in VB) if element has no child items.

Remarks

The child is the offspring one level lower than the specified item. If the specified item has no child items, this method will return a null reference (Nothing in VB). For example:

If the passed object points to:	The method returns an object pointing to:
Item 1	null
Item 2	Item 3
Item 4	Item 5
Item 6	null

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

A volatile element is an element that can be changed or destroyed in the process of inserting or setting an image. A non-volatile element is an element that must be changed manually; it is not changed or destroyed by inserting or setting an image.

For example, a grayscale image has elements DicomTag.SmallestImagePixelValue, DicomTag.LargestImagePixelValue, etc. If the image is changed to a color image, these elements disappear and the following elements appear: DicomTag.RedPaletteColorLookupTableDescriptor, etc. These are volatile elements since they are changed or destroyed when an image is changed or set.

To retrieve a child element that must be changed manually, i.e., is not volatile, set includeVolatile to false. To retrieve a child element that may be either volatile or non-volatile, set includeVolatile to true.

Example

For an example, refer to Load.

Requirements

Target Platforms