GetDim Method (VARIANT)

8.7, PLBCMP GUI Only

The GetDim method retrieves the number of dimensions defined for a VARIANT object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A VARIANT object that is accessed.

return

Optional. A Numeric Variable that receives the current number of dimensions for the VARIANT object.

Flags Affected: EOS, OVER, ZERO

Note the following:

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

2. The OVER and EOS Condition Flags are always cleared.

3. If the VARIANT object has a VARIANT array type ($VT_ARRAY), the returned value is the number of dimensions for the array. Otherwise, the returned value is zero.

See Also: Method Syntax, VARIANT Methods