GetItemParam Method (LISTVIEW)

PLBCMP GUI Only

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

[label]

{object}.GetItemParam

[GIVING {return}] USING [*Index=]{index}

Where:

label

object

Required. A LISTVIEW object that is accessed.

return

Optional. A Numeric Variable that returns the user parameter value.

index

Required. A zero-based decimal number or Numeric Variable that specifies the item or row accessed.

Flags Affected: EOS, OVER, ZERO

Note the following:

Upon completion, {return} will contain the user parameter value of the item within the object.
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, LISTVIEW Methods