All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspBranchConnection
System.IUnknown
|
+---CATIPspBranchConnection
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspBranchConnection
Interface to manage branch connections.
Role: To access branch connection data.
Method Index
- o
GetBranch(IUnknown*&,IUnknown*&)
- Get the branch route and connector.
- o
GetMain(IUnknown*&,IUnknown*&)
- Get the main route and connector.
Methods
o GetBranch
-
Get the branch route and connector.
- Parameters:
-
- oBranchRoute
- [out, IUnknown#Release] Branch route in branch connection.
- oCntrInBranch
- [out, IUnknown#Release] Extremity connector of the branch in branch connection.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetMain
-
Get the main route and connector.
- Parameters:
-
- oMainRoute
- [out, IUnknown#Release] Main route in branch connection.
- oCntrInMain
- [out, IUnknown#Release] Branch connector in branch connection.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspBranchConnection.h