GetItemParam Method (TREEVIEW)

PLBCMP GUI Only

The GetItemParam method returns the user parameter value for a specified item in a TREEVIEW object. The method uses the following format:

[label]

{object}.GetItemParam

[GIVING {return}] USING [*Item=]{item}

Where:

label

object

Required. A TREEVIEW object that is accessed.

return

Optional. A Numeric Variable that contains the user parameter value of the item.

item

Optional. A Numeric Variable that indicates the item within the object to access.

Flags Affected: EOS, OVER, ZERO

Note the following:

{item} is an item handle indicating the item within the object to access.
Upon completion, {return} will contain the user parameter value of the item.
If the value returned is zero, the ZERO Condition Flag is set.
If {return} is too small to contain the parameter value, the OVER Condition Flag is set.
The EOS Condition Flag is always cleared.

See Also: Method Syntax, TREEVIEW Methods