Retrieves the description for a linked partition. You specify the partition with a unique handle returned by an EssGGetCellLinkResults() function call.
Syntax
ESSG_FUNC_M EssGGetLinkedPartitionDesc (hGrid, hLRO, pConnectInfo);
| 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 must specify a linked object of type ESSG_PARTITIONTYPE. |
pConnectInfo; | ESSG_CONNECTINFO_T | Returns connection information for the linked partition. |
Notes
To retrieve descriptions for linked objects that are not partitions, use EssGGetLRODesc.
Return Value
If successful, returns ESSG_STS_NOERR.
See Also