ICapeReactionPropertiesGetReactionProp Method

Gets the value of the specified reaction property within a reactions object.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

[DispIdAttribute(1)]
Object GetReactionProp(
	string property,
	string phase,
	Object reacIds,
	string basis
)

VBRequest Example

<DispIdAttribute(1)>
Function GetReactionProp ( 
	property As String,
	phase As String,
	reacIds As Object,
	basis As String
) As Object

Parameters

property String

The Reaction Property to be retrieved.

phase String

The qualified phase for the Reaction Property.

reacIds Object

The qualified reactions for the Reaction Property. NULL to specify all reactions in the set.

basis String

Qualifies the basis of the Reaction Property (i.e., mass /mole). Default is mole. Use NULL only as a placeholder for property for which basis does not apply.

This qualifier could be extended with values such as activity, fugacity, fractions, molality…This way when an equilibrium constant is requested its basis can be specified.

Return Value

Object
The name of the base reactant for a particular reaction.

Remarks

The qualifiers passed in determine the reactions, phase and calculation basis for which the property will be got. The order of the array is the same as in the passed in reacIds array (i.e. property value for reaction reacIds[1] will be stored in property[1]).

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.