EssGGetLRODesc

Description

EssGGetLRODesc() retrieves the description information for a linked object. You specify the object with a unique handle returned by an EssGGetCellLinkResults() function call.

Syntax

ESSG_FUNC_M EssGGetLRODesc (hGrid, hLRO, pLroDesc);
ESSG_HGRID_ThGrid;
ESSG_HLRO_ThLRO;
ESSG_LPLRODESC_TpLroDesc;

Parameters

hGridGrid handle returned by EssGNewGrid().
hLROHandle to the linked partition (returned in a DRILLDATA structure by the EssGGetCellLinkResults() function). The handle can specify a linked object of any type except ESSG_PARTITIONTYPE.
pLroDescReturns an LRO description structure containing information about the specified object.

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

To retrieve descriptions for partitions (object type ESSG_PARTITIONTYPE), use EssGGetLinkedPartitionDesc().

See Also

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