All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspCntrFlow
System.IUnknown
|
+---CATIPspCntrFlow
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspCntrFlow
Interface to mangage Plant-Ship Connector Flow property.
Role: To query and modify Plant-Ship Connector Flow property.
Method Index
- o
GetFlowCapability(CATPspCntrFlowCapability&)
- Query the application Flow Capability property of this connector.
- o
GetFlowReality(CATPspCntrFlowReality&)
- Query the application Flow Reality property of this connector.
- o
SetFlowCapability(CATPspCntrFlowCapability)
- Set the application Flow Capability property of this connector.
- o
SetFlowReality(CATPspCntrFlowReality)
- Set the application Flow Reality property of this connector.
Methods
o GetFlowCapability
-
Query the application Flow Capability property of this connector.
- Parameters:
-
- oEFlowCapability
- Flow Capability.
- See also:
- CATPspCntrFlowCapability
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetFlowReality
-
Query the application Flow Reality property of this connector.
- Parameters:
-
- oEFlowReality
- Flow Reality.
- See also:
- CATPspCntrFlowReality
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetFlowCapability
-
Set the application Flow Capability property of this connector.
- Parameters:
-
- iEFlowCapability
- Flow Capability property to be set.
- See also:
- CATPspCntrFlowCapability
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetFlowReality
-
Set the application Flow Reality property of this connector.
- Parameters:
-
- iEFlowReality
- Flow Reality property to be set.
- See also:
- CATPspCntrFlowReality
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspCntrFlow.h