Retrieves a list of links resulting from a previous call to EssGBeginDrillOrLink().
Syntax
ESSG_FUNC_M EssGGetCellLinkResults (hGrid, pfCanDrill, pNumLROs, ppDrillData, pRangeOut, pState);
| Parameter | Data Type | Description |
|---|---|---|
hGrid; | ESSG_HGRID_T | Grid handle returned by EssGNewGrid(). |
pfCanDrill; | ESSG_PBOOL_T | Returns True if the cell has linked objects. If you request Zoom-In results by specifying the ESSG_OPT_ZOOM option with EssGBeginDrillOrLink(), pfCanDrill returns False. |
pNumLROs; | ESSG_PULONG_T | Returns the number of links retrieved. |
ppDrillData; | ESSG_DRILLDATA_T | Returns references to an array of ESSG_DRILLDATA_T structures containing information about the linked objects. |
pRangeOut; | ESSG_RANGE_T | Returns the cell ranges for the Zoom-In if no LROs were found and you specified the ESSG_OPT_ZOOM option in your call to EssGBeginDrillOrLink(). |
pState; | ESSG_PUSHORT_T | Returns one of the following states of operation:
|
Notes
This function allocates memory for ESSG_DRILLDATA_T. Release that memory with a call to EssGFreeCellLinkResults.
The handles retrieved from this function are valid until the next call to any of the following Grid API functions:
EssGBeginDrillOrLink()
EssGBeginCreateLRO()
EssGUpdateLRO()
EssGBeginDeleteLRO()
EssGDeleteLRO()
Return Value
If successful, returns ESSG_STS_NOERR.
See Also