ICape Reaction ChemistryGet Phase Compounds Method
Returns the number and ids of the compounds in the specified phase.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[DispIdAttribute(11)]
void GetPhaseCompounds(
string reacID,
ref int compNo,
ref Object compIds
)VB
<DispIdAttribute(11)>
Sub GetPhaseCompounds (
reacID As String,
ByRef compNo As Integer,
ByRef compIds As Object
)Parameters
- reacID String
- Label of the required phase.
- compNo Int32
- The number of compounds in the requested phase.
- compIds Object
- The ids of the compounds present in the specified phase.
Return Value
The name of the base reactant for a particular reaction.Remarks
Returns the number and ids of the compounds in the specified phase.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeFailedInitialisation | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeNoImpl | The error to be raised when other error(s), specified for this operation, are not suitable. |