All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Class CATEASchAppCntrDocLink

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATEASchAppCntrDocLink
 

Usage: you can derive this class.


public class CATEASchAppCntrDocLink

Super class to derive implementation for interface CATISchAppCntrDocLink.
Role: Adaptor


Constructor and Destructor Index


o CATEASchAppCntrDocLink()
Constructs an empty CATEASchAppCntrDocLink.
o ~CATEASchAppCntrDocLink()

Method Index


o AppGetLink(CATIUnknownList**,CATICStringList**,char**)
o AppGetLink2(CATIUnknownList**,CATListOfCATUnicodeString&,CATUnicodeString&)
Get a list of linked connector(s) and its document names or publication name.
o AppGetLinkedDocs(CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfInt&,CATLISTP(IUnknown)&)
Get a list of linked connectors, their documents' names, uuids, and 'open in session' statuses, and a publication name of the connectors.
o AppIsLinkable(CATISchAppConnector*,CATBoolean*)
Query whether this connector and input connector can be linked.
o AppLink(CATISchAppConnector*)
Create an external link to another connector.
o AppLinkInit(char*)
o AppLinkInit2(CATUnicodeString*)
Publish this connector to make it available for linking.
o AppOpenLinkedDoc(CATUnicodeString&,CATUnicodeString&,CATDocument*&)
Open a linked document.
o AppUnLink(int)
Remove external link to another connector.

Constructor and Destructor


o CATEASchAppCntrDocLink
public CATEASchAppCntrDocLink()
Constructs an empty CATEASchAppCntrDocLink.
o ~CATEASchAppCntrDocLink
public virtual ~CATEASchAppCntrDocLink()

Methods


o AppGetLink
public virtual HRESULT AppGetLink(CATIUnknownList** oLCntrs,
CATICStringList** oLDocumentNames,
char** oPublicationName)
Deprecated:
V5R15 Use CATEASchAppCntrDocLink.AppGetLink2 instead. Get a list of linked connector(s) and its document names or publication name.
Parameters:
oLCntrs
A list of connectors that are linked to this connector.
oLDocumentNames
A list of document names containing the linked connector.
oPublicationName
The publication name of the connector(s) linked to this connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppGetLink2
public virtual HRESULT AppGetLink2(CATIUnknownList** oLCntrs,
CATListOfCATUnicodeString& oLDocumentNames,
CATUnicodeString& oPublicationName)
Get a list of linked connector(s) and its document names or publication name.
Parameters:
oLCntrs
A list of connectors that are linked to this connector.
oLDocumentNames
A list of document names containing the linked connector.
oPublicationName
The publication name of the connector(s) linked to this connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppGetLinkedDocs
public virtual HRESULT AppGetLinkedDocs(CATUnicodeString& oPublicationName,
CATListOfCATUnicodeString& oLDocumentName,
CATListOfCATUnicodeString& oLDocumentUuid,
CATListOfInt& oLOpenStatus,
CATLISTP(IUnknown)& oLCntr)
Get a list of linked connectors, their documents' names, uuids, and 'open in session' statuses, and a publication name of the connectors.
Parameters:
oPublicationName
The publication name of the connector(s) linked to this connector.
oLDocumentName
A list of document names of the documents containing the linked connector(s).
oLDocumentUuid
A list of document UUIDs of the documents containing the linked connector(s).
oLOpenStatus
A list of integer flags specifying whether a linked document is open in the session or not (1 - yes; 0 - no).
oLCntr
A list of connectors that are linked to this connector. Release every member (AddRef has been done).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppIsLinkable
public virtual HRESULT AppIsLinkable( const CATISchAppConnector* iSchConnector,
CATBoolean* oBYes)
Query whether this connector and input connector can be linked.
Parameters:
iSchConnector
The connector to link to.
oBYes
If TRUE, connectors can be linked.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppLink
public virtual HRESULT AppLink( const CATISchAppConnector* iSchConnector)
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 AppLinkInit
public virtual HRESULT AppLinkInit( const char* iPublicationName= NULL)
Deprecated:
V5R15 Use CATISchAppCntrDocLink.AppLinkInit2 instead. Publish this connector to make it available for linking.
Parameters:
iPublicationName
The publication name of connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppLinkInit2
public virtual HRESULT AppLinkInit2(CATUnicodeString* iPublicationName= NULL)
Publish this connector to make it available for linking.
Parameters:
iPublicationName
The publication name of connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppOpenLinkedDoc
public virtual HRESULT AppOpenLinkedDoc( const CATUnicodeString& iDocumentName,
const CATUnicodeString& iDocumentUuid,
CATDocument*& oDocument)
Open a linked document.
Parameters:
iDocumentName
Name of the document (from oLDocumentName list in AppGetLinkedDocs()).
iDocumentUuid
Uuid of the document (from oLDocumentUuid list in AppGetLinkedDocs()).
oDocument
Pointer to the document. Do not release (no AddRef is done).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppUnLink
public virtual HRESULT AppUnLink( const int iUnpublish= 0)
Remove external link to another connector.
Parameters:
iUnpublish
iUnpublish = 0, do not delete publication connector (default) iUnpublish > 0, delete publication connector
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATEASchAppCntrDocLink.h
If needed, your Imakefile.mk should include the module: CATSchItfCPP

Copyright © 2003, Dassault Systèmes. All rights reserved.