EssGGetLRO

Retrieves a LRO from an Essbase database.

Syntax

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

Parameter	Data Type	Description
hGrid	ESSG_HGRID_T	Grid handle returned by EssGNewGrid().
hLRO	ESSG_HLRO_T	Handle to the linked object (returned in a DRILLDATA structure by the EssGGetCellLinkResults() function).
szTargetFile	ESSG_STR_T	The name of the target file, including path, into which the object is retrieved.
ulOption	ESSG_ULONG_T	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.

Notes

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

Return Value

If successful, returns ESSG_STS_NOERR.