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_ThGrid;
ESSG_PBOOL_TpfCanDrill;
ESSG_PULONG_TpNumLROs;
ESSG_PPDRILLDATA_T ppDrillData;
ESSG_PRANGE_T pRangeOut;
ESSG_PUSHORT_TpState;

Parameters

hGridGrid handle returned by EssGNewGrid().
pfCanDrillReturns 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.
pNumLROsReturns the number of links retrieved.
ppDrillDataReturns references to an array of ESSG_DRILLDATA_T structures containing information about the linked objects.
pRangeOutReturns 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().
pStateReturns 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

See Also

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