All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchCntrDocLink
System.IUnknown
|
+---CATISchCntrDocLink
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchCntrDocLink
Interface to manage the external link of connectors
across documents.
Role: To modify or query a connector's external link.
Method Index
- o
GetLink(CATISchAppConnector**,char**)
-
- o
GetLink2(CATISchAppConnector**,CATUnicodeString&)
- Get the linked connector and its document name.
- o
Link(CATISchAppConnector*)
- Create an external link to another connector.
- o
UnLink()
- Remove external link to another connector.
Methods
o GetLink
-
- Deprecated:
- V5R15
Use
CATISchCntrDocLink.GetLink2 instead. Get the linked connector and its document name.
- Parameters:
-
- oSchConnector
- The connector that is linked to this connector.
- oDocumentName
- Name of document containing the linked connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetLink2
-
Get the linked connector and its document name.
- Parameters:
-
- oSchConnector
- The connector that is linked to this connector.
- oDocumentName
- Name of document containing the linked connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Link
-
Create an external link to another connector.
- Parameters:
-
- iSchConnector
- The connector to link to.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o UnLink
-
Remove external link to another connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchCntrDocLink.h