# EssGGetRows

Description

EssGGetRows() retrieves data after an operation has been completed.

Syntax

    ESSG_FUNC_M EssGGetRows (hGrid, ulOptions, pRangeRequested,
    pRangeOut, pppDataOut);

ESSG_HGRID_T | hGrid
ESSG_ULONG_T | ulOptions
ESSG_PRANGE_T | pRangeRequested
ESSG_PRANGE_T | pRangeOut
ESSG_PPDATA_T | *pppDataOut

Parameters

hGrid | Handle passed back from EssGNewGrid.
ulOptions | Reserved for future use. Should be set to zero.
pRangeRequested | Describes the extent of the data requested. This can be less than or equal to the number of rows and columns returned from the EssGGetResults call.
pRangeOut | Describes the extent of the data returned.
pppDataOut | The address of a two-dimensional array of data. The memory for this array is allocated by the API and should be freed by the caller using EssGFreeRows.

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

- Retrieves data after an operation has been completed (EssGBegin, EssGSendRows, EssGPerformOperation, EssGGetResults).
- You can make multiple calls to EssGGetRows, but the pRangeRequested->ulStartRow in each subsequent call must be greater than the last row received.
- The pRangeRequested variable should define the rows desired to be returned. If multiple buffers of data are being returned, each subsequent call to EssGGetRows should update the rows in the pRangeRequested parameter.
- If the caller requests rows where some of the requested rows are valid, while others are out of range, the valid rows will be filled in. The invalid rows remain undefined.
- If the caller requests rows that are completely out of range from the information that is available, an error is returned.

Access

None.

Example

             sts = EssGGetRows(hGrid, 0, &rDataRangeOut,
             &rDataRangeOut, &ppDataOut);

See an example that uses this code in the EssGBeginRetrieve Example section.

See Also

Using the Grid API Functions
Grid API Structures