GetAllData Method (VARIANT)

8.7, PLBCMP GUI Only

The GetAllData method retrieves all of the elements of a VARIANT object with a VT_ARRAY variant type and stores them into a single DIM.

Where:

label

Optional. A Program Execution Label.

object

Required. A VARIANT object that is accessed.

return

Optional. A Character String Variable that receives the VT_ARRAY data elements.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. Each VT_ARRAY data element is stored as a VT_BSTR data string and is terminated with a 0x0A character.

2. The EOS flag is set if the size of the {return} variable is too small to hold all of the VARIANT array data.

3. The ZERO and OVER flags are always set to FALSE.

4. The number of VT_ARRAY elements retrieved from the VARIANT object can be determined by using the OCCURS instruction to count the number of 0x0As in the {return} variable.

See Also: Method Syntax, VARIANT Methods