CapeParameterValStatus Property

Gets the flag to indicate parameter validation's status.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
public CapeValidationStatus ValStatus { get; }

Property Value

CapeValidationStatus
The validity staus of the parameter, either valid, invalid, or "not validated".

Implements

ICapeParameterValStatus

Remarks

Gets the flag to indicate parameter validation status. It has three possible values:

(i) notValidated(CAPE_NOT_VALIDATED): The PMC's Validate() method has not been called after the last time that its value had been changed.

(ii) invalid(CAPE_INVALID): The last time that the PMC's Validate() method was called it returned false.

(iii) valid(CAPE_VALID): the last time that the PMC's Validate() method was called it returned true.

Exceptions

ECapeUnknownThe error to be raised when other error(s), specified for this operation, are not suitable.
ECapeInvalidArgumentTo be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument.

See Also