# EssGGetLRO

Description

EssGGetLRO() retrieves a linked reporting object from an Essbase database.

Syntax

    ESSG_FUNC_M EssGGetLRO (hGrid, hLRO, szTargetFile, ulOption);

ESSG_HGRID_T | hGrid
ESSG_HLRO_T | hLRO
ESSG_STR_T | szTargetFile
ESSG_ULONG_T | ulOption

Parameters

hGrid | Grid handle returned by EssGNewGrid().
hLRO | Handle to the linked object (returned in a DRILLDATA structure by the EssGGetCellLinkResults() function).
szTargetFile | The name of the target file, including path, into which the object is retrieved.
ulOption | Option specifying whether to retrieve the object, its catalog entry, or both. Use one of the following: ESS_LRO_OBJ_API to retrieve only the object. ESS_LRO_CATALOG_API to retrieve only the catalog entry. ESS_LRO_BOTH_API to retrieve object and catalog entry.

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

To retrieve a cell note, use EssGGetLRODesc(). EssGGetLRO does not retrieve cell note information.

See Also

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