OLEDBSimpleProvider::getVariant

Retrieves the value of the cell at the indicated row and column into the pre-allocated variant supplied in pVar.

getVariant uses the following enumeration:

typedef enum OSPFORMAT {
OSPFORMAT_RAW = 0,
OSPFORMAT_DEFAULT = 0,
OSPFORMAT_FORMATTED = 1,
OSPFORMAT_HTML = 2,
};

where

Value	Meaning
OSPFORMAT_RAW OSPFORMAT_DEFAULT	Underlying column type should be used to set or get the value (the default).
OSPFORMAT_FORMATTED	Underlying column type should be converted to a string, and the string returned as a BSTR within the variant. It is mandatory for OSP developers to support the fFormatted argument of getVariant with this value.
OSPFORMAT_HTML	Underlying column type should be converted to an HTML string.

HRESULT getVariant (
LONGiRow,
LONGiColumn,
OSPFORMATfFormatted,

VARIANT*pVar);

Parameters

iRow

[in]
Position of the specified row.

iColumn

[in]
Position of the specified column.

fFormatted

[in]
Enumerated value that determines the format in which to return the cell value's underlying column type (see previous table and Notes).

pVar

[out]
Based on the value specified in the pVar parameter, pVar will contain either:

Return Codes

S_OK
The method succeeded.

E_FAIL
A provider-specific error occurred.

Notes

getVariant does not support references.
For the fFormatted argument, it is mandatory for OSP developers to support getVariant with a value of OSPFORMAT_FORMATTED. The OSP implementation is responsible for type conversion, and in the case of Boolean values, the correctly formatted string must be either "True" or "False".
When OSPFORMAT_HTML is requested, the provider may, at its option, return a plain string (for example, unadorned with HTML tags).
A data value of NULL is indicated by returning either:
1. S_OK and a Variant of type VT_NULL, or
2. S_FALSE and pVar will be ignored
for any of the fFormatted types.
Do not use a value of -1 as an argument with the iRow and iColumn arguments of getVariant. You must retrieve table cells individually; they cannot be retrieved a row or column at a time.