All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchAppConnector

System.IUnknown
  |
  +---CATISchAppConnector
 

Usage: you can freely reimplement this interface.


interface CATISchAppConnector

Interface to mangage application connector object behaviors.
Role: To specify application connector behaviors such as connect and disconnect.


Method Index


o AppConnect(CATISchAppConnector*,CATISchAppConnection**)
Connect to an input connector.
o AppConnectBranch(CATISchAppConnector*,CATISchAppConnection**)
Connect to an input connector for Branch.
o AppDisconnect(CATISchAppConnector*)
Disconnect from an input connector.
o AppGetAssociatedConnectable(CATISchAppConnectable**)
Find the application object that owns this connector.
o AppIsCntrConnected(CATBoolean*)
Query whether the connector has been connected.
o AppListCompatibleTypes(CATICStringList**)
Find all the class types of connector that are compatible with this connector for connections.
o AppListConnections(CATICStringList*,CATIUnknownList**)
Find all the connections that include this connector.
o AppOKToNoShowConnectedCntr(CATBoolean*)
Query whether it is OK to no show the connector after it is connected.

Methods


o AppConnect
public virtual HRESULT AppConnect(CATISchAppConnector* iCntrToConnect,
CATISchAppConnection** oConnection) = 0
Connect to an input connector.
Parameters:
iCntrToConnect
A schematic connector object to connect to
oConnection
Connection created
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppConnectBranch
public virtual HRESULT AppConnectBranch(CATISchAppConnector* iCntrToConnect,
CATISchAppConnection** oConnection) = 0
Connect to an input connector for Branch.
Parameters:
iCntrToConnect
A schematic connector object to connect to
oConnection
Connection created
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppDisconnect
public virtual HRESULT AppDisconnect(CATISchAppConnector* iCntrToDisConnect) = 0
Disconnect from an input connector.
Parameters:
iCntrToDisconnect
A schematic connector object to disconnect from
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppGetAssociatedConnectable
public virtual HRESULT AppGetAssociatedConnectable(CATISchAppConnectable** oConnectable) = 0
Find the application object that owns this connector.
Parameters:
oConnectable
An application object that the connector belongs to.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppIsCntrConnected
public virtual HRESULT AppIsCntrConnected(CATBoolean* oBYes) = 0
Query whether the connector has been connected.
Parameters:
oBYes
If TRUE, then it is connected
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppListCompatibleTypes
public virtual HRESULT AppListCompatibleTypes(CATICStringList** oLCntrCompatClassTypes) = 0
Find all the class types of connector that are compatible with this connector for connections.
Parameters:
oLCntrCompatClassTypes
A list of all the class types of connectors that are compatible with this connector for connections.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppListConnections
public virtual HRESULT AppListConnections(CATICStringList* iLCntnClassFilter,
CATIUnknownList** oLConnections) = 0
Find all the connections that include this connector.
Parameters:
oLCntnClassFilter
A list of all the class types for filtering the output connection list.
oLConnections
A list of connections that include this connector (members are CATISchAppConnection interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppOKToNoShowConnectedCntr
public virtual HRESULT AppOKToNoShowConnectedCntr(CATBoolean* oBYes) = 0
Query whether it is OK to no show the connector after it is connected.
Parameters:
oBYes
If TRUE, then it is OK to no show.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchAppConnector.h

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