GetNextItem Method (TREEVIEW)

PLBCMP GUI Only

The GetNextItem method returns the next item handle in a TREEVIEW object based on the specified action code. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A TREEVIEW object that is accessed.

return

Optional. A Numeric Variable that returns the next item handle.

item

Required. A decimal number or Numeric Variable that indicates the starting item handle.

code

Required. A decimal number or Numeric Variable that indicates an action from the table below.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. {item} is an item handle indicating the starting item.

2. {code} is a numeric variable or a constant as defined in PLBMETH.INC indicating one of the following actions:

 

Value	Constant	Returns the ...
0x0	TVGN_ROOT	first child item of the root item.
0x1	TVGN_NEXT	next sibling item.
0x2	TVGN_PREVIOUS	previous sibling item.
0x3	TVGN_PARENT	parent of the item
0x4	TVGN_CHILD	first child item.
0x5	TVGN_FIRSTVISIBLE	first visible item.
0x6	TVGN_NEXTVISIBLE	next visible item.
0x7	TVGN_PREVIOUSVISIBLE	first visible item that precedes the given item.
0x8	TVGN_DROPHILITE	item that is the target of a drag-and-drop operation.
0x9	TVGN_CARET	currently selected item.

3. Upon completion, {return} will contain the next item handle within the TREEVIEW. If the method fails, a zero is returned.

4. If the value returned is zero, the ZERO Condition Flag is set.

5. If {return} is too small to contain the next item handle, the OVER Condition Flag is set. To ensure correct results, {return} should be defined as a four byte INTEGER or a ten byte FORM.

6. The EOS Condition Flag is always cleared.

See Also: Method Syntax, TREEVIEW Methods