SetTabParam Method (TABCONTROL)

PLBCMP GUI Only, 9.4C

The SetTabParam method stores a user data parameter for a tab in a TABCONTROL object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A TABCONTROL object that is accessed.

return

Optional. A Numeric Variable whose value is the user data parameter value is to be set.

index

Required. A decimal number or Numeric Variable whose value identifies the tab to be accessed.

param

Required. A decimal number or Number Variable that identifies the parameter value to be set.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The {param} value is limited to a thirty-two (32) bit value from zero (0) to 0xFFFFFFFF.

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

2. If the execution of the method is unsuccessful, the {return} value is zero.

3. If the execution of the method is successful, the {return} value is non-zero.

4. The {index} is a zero relative numeric value that identifies the TABCONTROL tab.

5. The OVER Condition Flag is set if the {return} value is too large to be stored without truncation.

6. The EOS Condition Flag are always cleared.

See Also: Method Syntax, TABCONTROL Methods