# EssGGetCellLinkResults

Description

EssGGetCellLinkResults() retrieves a list of links resulting from a previous call to EssGBeginDrillOrLink().

Syntax

    ESSG_FUNC_M EssGGetCellLinkResults (hGrid, pfCanDrill, pNumLROs,
    ppDrillData, pRangeOut, pState);

ESSG_HGRID_T | hGrid;
ESSG_PBOOL_T | pfCanDrill;
ESSG_PULONG_T | pNumLROs;
ESSG_PPDRILLDATA_T | ppDrillData;
ESSG_PRANGE_T | pRangeOut;
ESSG_PUSHORT_T | pState;

Parameters

hGrid | Grid handle returned by EssGNewGrid().
pfCanDrill | 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 | Returns the number of links retrieved.
ppDrillData | Returns references to an array of ESSG_DRILLDATA_T structures containing information about the linked objects.
pRangeOut | 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 | Returns one of the following states of operation: In progress - meaning not all cells have been retrieved. Done - meaning all cells have been retrieved.

Return Value

If successful, returns ESSG_STS_NOERR.

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()

See Also

Using the Grid API Functions
Grid API Structures
EssgBeginRemoveOnly()
EssGGetOption()
EssGPerformOperation()
EssGSetOption()
EssGBeginCreateLRO()
EssGBeginDrillAcross()
EssGBeginDeleteLROs()
EssGBeginDrillOrLink()
EssGDeleteLRO()
EssGFreeCellLinkResults()
EssGGetLRODesc()
EssGGetLinkedPartitionDesc()
EssGGetLRO()
EssGUpdateLRO()