GetTabImage Method (TABCONTROL)

PLBCMP GUI Only, 9.4C

The GetTabImage method retrieves the current image index 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 image index value that is assigned to the specified tab.

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 0xFFFFFFFE.

3. If the execution of the method is successful, the {return} value is the index value of an image in the imagelist that is set for the TABCONTROL object.

4. If there no image index set for the tab specified by the {index}, the return} value is 0xFFFFFFFF.

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

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

7. The EOS Condition Flag are always cleared.

See Also: Method Syntax, TABCONTROL Methods