ICape
Gets the phase on which a particular reaction contained in the Reactions Package will take place.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
The phase label of the phase where the reaction tackes place.
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[DispIdAttribute(7)]
string GetReactionPhase(
string reacId
)VB
<DispIdAttribute(7)>
Function GetReactionPhase (
reacId As String
) As StringParameters
- reacId String
- The name of the reaction obtained from the GetReactionsIds method.
Return Value
StringThe phase label of the phase where the reaction tackes place.
Remarks
The string returned by this method must match one of the phase labels known to the Property Package.
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. |