# EssGGetLinkedPartitionDesc

Description

EssGGetLinkedPartitionDesc() 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);

ESSG_HGRID_T | hGrid;
ESSG_HLRO_T | hLRO;
ESSG_PCONNECTINFO_T | pConnectInfo;

Parameters

hGrid | Grid handle returned by EssGNewGrid().
hLRO | 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 | Returns connection information for the linked partition.

Return Value

If successful, returns ESSG_STS_NOERR.

Notes

To retrieve descriptions for linked objects that are not partitions, use EssGGetLRODesc().

See Also

Using the Grid API Functions
Grid API Structures
EssgBeginRemoveOnly()
EssGGetCellLinkResults()
EssGGetOption()
EssGPerformOperation()
EssGSetOption()
EssGBeginCreateLRO()
EssGBeginDrillAcross()
EssGBeginDeleteLROs()
EssGBeginDrillOrLink()
EssGDeleteLRO()
EssGFreeCellLinkResults()
EssGGetCellLinkResults()
EssGGetLRODesc()
EssGGetLRO()
EssGUpdateLRO()