EssGBeginCreateLRO

Description

EssGBeginCreateLRO() begins the operation of creating a linked object for a data cell in an Essbase database.

Syntax

ESSG_FUNC_M EssGBeginCreateLRO (hGrid, usCells, pCells, pLroDesc, 
ulOption);
ESSG_HGRID_ThGrid;
ESSG_USHORT_TusCells;
ESSG_PRANGE_T pCells;
ESSG_PLRODESC_T pLroDesc;
ESSG_ULONG_TulOption;

Parameters

hGridGrid handle returned by EssGNewGrid().
usCellsThe number of cell ranges specified in pCells.
pCellsArray of cell ranges for which to create the link.
pLroDescLRO description information for the new object.
ulOptionOption specifying whether to store the object on the server. Use ESS_STORE_OBJECT_API to store winapp and URL objects on the server. Use ESS_NOSTORE_OBJECT_API to store cell notes off the server (and in the index file).

Return Value

If successful, returns ESSG_STS_NOERR.

See Also

Using the Grid API Functions
Grid API Structures
EssGBeginDeleteLROs()
EssGBeginDrillOrLink()
EssGDeleteLRO()
EssGFreeCellLinkResults()
EssGGetCellLinkResults()
EssGGetLRODesc()
EssGGetLRO()
EssGUpdateLRO()