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);
| Parameter | Data Type | Description |
|---|---|---|
hGrid; | ESSG_HGRID_T | Grid handle returned by EssGNewGrid(). |
hLRO; | ESSG_HLRO_T | Handle 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. |
pLroDesc; | ESSG_LPLRODESC_T | Returns an LRO description structure containing information about the specified object. |
Notes
To retrieve descriptions for partitions (object type ESSG_PARTITIONTYPE), use EssGGetLinkedPartitionDesc.
Return Value
If successful, returns ESSG_STS_NOERR.
See Also