EssGUpdateLRO

Description

EssGUpdateLRO() updates the description and contents of a linked object.

Syntax

ESSG_FUNC_M EssGUpdateLRO (hGrid, hLRO, pLroDesc, ulOption);
ESSG_HGRID_ThGrid;
ESSG_HLRO_ThLRO;
ESSG_PLRODESC_T pLroDesc;
ESSG_ULONG_TulOption;

Parameters

hGridGrid handle returned by EssGNewGrid().
hLROHandle to the linked object (returned in a DRILLDATA structure by the EssGGetCellLinkResults() function).
pLroDescA structure containing information about the LRO to be updated.
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
EssGBeginCreateLRO()
EssGBeginDeleteLROs()
EssGDeleteLRO()
EssGGetLRODesc()