VARABSVALUE Property

PLBCMP GUI Only

The VARABSVALUE property retrieves the current absolute or raw data for a VARIANT object. The property uses the following format:

VARABSVALUE={value}

Note the following:

1. VARABSVALUE may be used in GETPROP statements of a VARIANT object.

2. {value} must be a DIM variable or array.

3. The format of the data depends on the VARIANT type and is the same as described for a VARIANT in Windows documentation.

4. The actual number of bytes retrieved depends on the VARIANT type. The following table identifies the expected number of bytes retrieved for the raw data:

 

Variant Type	Byte Size	Comment
$VT_EMPTY	0	nothing
$VT_NULL	0	SQL style Null
$VT_I2	2	2 byte signed int
$VT_I4	4	4 byte signed int
$VT_R4	4	4 byte real
$VT_R8	8	8 byte real
$VT_CY	8	currency
$VT_DATE	8	date
$VT_BSTR	nnn	Unicode string
$VT_DISPATCH	4	IDispatch FAR*
$VT_ERROR	4	SCODE
$VT_BOOL	2	True=-1, False=0
$VT_VARIANT	4	VARIANT FAR*
$VT_UNKNOWN	4	IUnknown FAR*
$VT_UI1	1	unsigned char

 

5. When used in a SETPROP instruction and {value} is a DIM array reference with no specified index, a VARIANT BSTR may be set with a total length greater than 65535.

6. When used in a GETPROP instruction to accept a DIM array reference with no specified index, a VARIANT BSTR with a total length greater than 65535 may be retrieved. When a DIM array is used in this manner, the BSTR data is moved into each array element starting with the first array element and continuing with each successive array element as determined by a row major sequence until BSTR data or the DIM array elements are exhausted. If the BSTR data is exhausted, any additional DIM array elements beyond that point are set to NULL. The EOS flag is set if there is an insufficient number of array elements to contain all of the BSTR data.

See Also: Object Properties, Object IO Instructions, Object Definitions