←Select platform

GetNextKey Method

Summary

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

Syntax
C#
VB
Java
C++
public DicomElement GetNextKey( 
   DicomElement element, 
   bool tree 
) 
Public Function GetNextKey( _ 
   ByVal element As DicomElement, _ 
   ByVal tree As Boolean _ 
) As DicomElement 
public DicomElement getNextKey(DicomElement element, boolean tree) 
public: 
DicomElement^ GetNextKey(  
   DicomElement^ element, 
   bool tree 
)  

Parameters

element
An item in the Data Set. The item in the Data Set that immediately follows this item will be returned.

tree
true to evaluate the Data Set as a tree; false to evaluate the Data Set as a list.

Return Value

The item in the Data Set that immediately follows the item specified by element, or a null reference (Nothing in VB) if there is no item following element (element is the last item in the Data Set).

Remarks

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

If the passed object points to: The method returns an object pointing 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 the following illustration does indicate the order of the items when the Data Set is evaluated as a list.

getntlst.gif
If the passed object points to: The method returns an object pointing 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 methods will also help you navigate the Data Set as either a tree or a list:

GetFirstKey

GetPreviousKey

GetLastKey

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

GetRootKey

GetParentKey

GetChildKey

Example

For an example, refer to Reset.

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom Assembly