All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspConnection

System.IUnknown
  |
  +---CATIPspConnection
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIPspConnection

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


Method Index


o ListConnectables(CATICStringList*,CATIUnknownList**,CATIUnknownList**)
Find all the object connected to this connection through their connectors.
o ListConnectors(CATICStringList*,CATIUnknownList**)
Find all the connectors included in this connection.

Methods


o ListConnectables
public virtual HRESULT ListConnectables(CATICStringList* iLCntbleClassFilter,
CATIUnknownList** oLCntbles,
CATIUnknownList** oLCntrs) = 0
Find all the object connected to this connection through their connectors.
Parameters:
iLCntbleClassFilter
A list of all the class types for filtering the output objects list.
oLCntbles
[out, IUnknown#Release] A list of objects connected to this connection. (members are CATIPspConnectable interface pointers).
oLCntrs
[out, IUnknown#Release] A list of connectors through which this connection is made. (members are CATIPspConnector interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectors
public virtual HRESULT ListConnectors(CATICStringList* iLCntrClassFilter,
CATIUnknownList** oLCntrs) = 0
Find all the connectors included in this connection.
Parameters:
iLCntrClassFilter
A list of all the class types for filtering the output connector list.
oLCntrs
[out, IUnknown#Release] A list of connectors included in this connection. (members are CATIPspConnector interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspConnection.h

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