EssGGetRows

Retrieves data after an operation has been completed (EssGBegin, EssGSendRows, EssGPerformOperation, EssGGetResults).

Syntax

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

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.
pRangeRequested	ESSG_RANGE_T	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	ESSG_RANGE_T	Describes the extent of the data returned.
*pppDataOut	ESSG_DATA_T	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.

Notes

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.

Return Value

If successful, returns ESSG_STS_NOERR.

Access

None.

Example

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

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