GetTabParam Method (TABCONTROL)

PLBCMP GUI Only, 9.4C

The GetTabParam method retrieves the current user data parameter that is assigned to a tab for 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 that has been previously set.

index

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

Flags Affected: EOS, OVER, ZERO

Note the following:

1. 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 (0).

3. If the execution of the GetTabParam method is successful, the {return} value is the current user data parameter that is assigned to the tab. If a user data parameter has never been set for a tab, the {return} value is expected to be zero (0).

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