ICape Reaction ChemistryGet Reaction Compound Ids Method
Get the identifiers of the components participating in the specified reaction
within the reaction set defined in the Reactions Package.
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(5)]
void GetReactionCompoundIds(
string reacId,
ref Object compIds,
ref Object compCharge,
ref Object compCASNumber
)VB
<DispIdAttribute(5)>
Sub GetReactionCompoundIds (
reacId As String,
ByRef compIds As Object,
ByRef compCharge As Object,
ByRef compCASNumber As Object
)Parameters
- reacId String
- The name of the reaction obtained from the GetReactionsIds method.
- compIds Object
- List of compound IDs.
- compCharge Object
- The charge for each compound.
- compCASNumber Object
- The CAS Registry numbers for the compounds.
Remarks
This method returns both compound name and CAS registry number. The CAS Registry
number should be used to identify the compounds for validation purposes because
it is unambiguous.
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. |