MoveFirstIOD method (ILEADDicomDS)

VB.NET example

C# example

Visual Basic example

Visual C++ 6.0 example

 

Syntax

short MoveFirstIOD ( BOOL bTree );

Overview

Refer to Working with Information Object Definitions.

Remarks

Updates the CurrentIOD property to the first item in the IOD Structure. The result depends on whether the IOD Structure is evaluated as a list or a tree.

If the IOD Structure is evaluated as a tree structure, this method updates the CurrentIOD property with the first item on the same level and with the same parent as the item contained in the CurrentIOD property. Please note that the numbering of the items in this first illustration is arbitrary and does not imply order.

image\GetFstTr.gif

 

If the CurrentIOD property contains:

The CurrentIOD property will be updated with:

Item 1

Item 2

Item 3

Item 4

Item 5

Item 5

Item 6

Item 7

NULL

Item 2

If the IOD Structure is evaluated as a list, the CurrentIOD property is updated with the first item in the list. Please note that the numbering of the items in this illustration does indicate the order of the items when the IOD Structure is evaluated as a list.

image\GetFtLst.gif

 

If the CurrentIOD property contains:

The CurrentIOD property will be updated with:

NULL

Item 1

Item 12

Item 1

Item 14

Item 1

Item 22

Item 1

Item 25

Item 1

The following methods will also help you navigate the IOD Structure as either a tree or a list:

MoveGetLastIOD method

MovePrevIOD method

MoveNextIOD method

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

MoveRootIOD method

MoveParentIOD method

MoveChildIOD method

Note: Visual Basic users can either check the return value of the method, or capture and process errors to determine whether the MovexxxIOD methods have completed successfully. For an example of capturing errors, refer to any of the MovexxxIOD method examples.

See Also

Elements:

MoveLastIOD method, MovePrevIOD method, MoveNextIOD method, MoveRootIOD method, MoveParentIOD method, MoveChildIOD method

Topics:

Information Object Definitions: Maneuvering Through the IOD Table