All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchAppConnection

System.IUnknown
  |
  +---CATISchAppConnection
 

Usage: you can freely reimplement this interface.


interface CATISchAppConnection

Interface to mangage application connection object behaviors.
Role: To specify application connection behaviors such as adding a connector and removing a connector.


Method Index


o AppAddConnector(CATISchAppConnector*)
Add a connector.
o AppListConnectables(CATICStringList*,CATIUnknownList**,CATIUnknownList**)
Find all the application object connected to this connection through their connectors.
o AppListConnectors(CATICStringList*,CATIUnknownList**)
Find all the connectors included in this connection.
o AppRemoveConnector(CATISchAppConnector*)
Remove a connector.

Methods


o AppAddConnector
public virtual HRESULT AppAddConnector(CATISchAppConnector* iCntrToAdd) = 0
Add a connector.
Parameters:
iCntrToAdd
The Application Connector to be added to the connection
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppListConnectables
public virtual HRESULT AppListConnectables(CATICStringList* iLCntbleClassFilter,
CATIUnknownList** oLCntbles,
CATIUnknownList** oLCntrs) = 0
Find all the application object connected to this connection through their connectors.
Parameters:
oLCntrClassFilter
A list of all the class types for filtering the output application objects list.
oLCntbles
A list of application objects connected to this connection. (members are CATISchAppConnectable interface pointers).
oLCntrs
A list of connectors through which this connection is made. (members are CATISchAppConnector interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppListConnectors
public virtual HRESULT AppListConnectors(CATICStringList* iLCntrClassFilter,
CATIUnknownList** oLCntrs) = 0
Find all the connectors included in this connection.
Parameters:
oLCntrClassFilter
A list of all the class types for filtering the output connector list.
oLCntrs
A list of connectors included in this connection. (members are CATISchAppConnector interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppRemoveConnector
public virtual HRESULT AppRemoveConnector(CATISchAppConnector* iCntrToRemove) = 0
Remove a connector.
Parameters:
iCntrToRemove
The Application Connector to be removed
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchAppConnection.h

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