EssGGetResults

Description

EssGGetResults() retrieves information about the data returned after an operation has been completed.

Syntax

ESSG_FUNC_M EssGGetResults (hGrid, ulOptions, pRangeOut, pState);
ESSG_HGRID_T hGrid
ESSG_ULONG_T ulOptions
ESSG_PRANGE_T pRangeOut
ESSG_PUSHORT_T pState

Parameters

hGridHandle passed back from EssGNewGrid.
ulOptionsReserved for future use. Should be set to zero.
pRangeOutDescribes 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.
pStateVariable for the return of the state of the operation. This can be one of the following values:
  • ESSG_STATE_DONE   Operation complete
  • ESSG_STATE_INPROGRESS   The operation is in progress

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

Access

None.

Example

    sts = EssGGetResults(hGrid, 0, &rDataRangeOut, &usState);
See an example that uses this code in the EssGBeginRetrieve Example section.

See Also

Using the Grid API Functions
Grid API Structures