Retrieves information about the data returned after an operation has been completed (EssGBeginXxx, EssGSendRows, EssGPerformOperation).
Syntax
ESSG_FUNC_M EssGGetResults (hGrid, ulOptions, pRangeOut, pState);
Parameter | Data Type | Description |
---|---|---|
hGrid | ESSG_HGRID_T | Handle passed back from EssGNewGrid. |
ulOptions | ESSG_ULONG_T | Reserved for future use. Should be set to zero. |
pRangeOut | ESSG_RANGE_T | Describes the extent of the data returned from the server. This parameter describes the total amount of data that will be returned. The caller can break up the retrieval with multiple calls to EssGGetRows. |
pState | ESSG_PUSHORT_T | Variable for the return of the state of the operation. This can be one of the following values:
|
Notes
After this call is made and the pState variable contains ESSG_STATE_DONE, the caller should call EssGGetRows to retrieve the actual data from the server.
Return Value
If successful, returns ESSG_STS_NOERR.
Access
None.
Example
sts = EssGGetResults(hGrid, 0, &rDataRangeOut, &usState);
See an example that uses this code in the EssGBeginRetrieve Example section.
See Also