ICape Thermo Equilibrium ServerProp Check Method
Checks that a property is valid.
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(2)]
void PropCheck(
Object materialObject,
string flashType,
Object props,
ref Object valid
)VB
<DispIdAttribute(2)>
Sub PropCheck (
materialObject As Object,
flashType As String,
props As Object,
ByRef valid As Object
)Parameters
- materialObject Object
- The material object of the calculation.
- flashType String
- Flash calculation type.
- props Object
- Properties to be calculated at equilibrium. emptyVariant for no properties. If a list, then the property values should be set for each phase present at equilibrium.
- valid Object
- The array of booleans for flash and property. First element is reserved for flashType.
Remarks
Checks to see if a given type of flash calculations can be performed and whether the properties can
be calculated after the flash calculation.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | To be used when an invalid argument value was passed, for example UNDEFINED for property. |