Real
Validates the current value of the parameter against the
specification of the parameter.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
True if the parameter is valid, false if not valid.
ICapeParameterValidate(String)
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
public override bool Validate(
ref string message
)VB
Public Overrides Function Validate (
ByRef message As String
) As BooleanParameters
- message String
- Reference to a string that will conain a message regarding the validation of the parameter.
Return Value
BooleanTrue if the parameter is valid, false if not valid.
Implements
ICapeParameterValidate(String)ICapeParameterValidate(String)
Remarks
The parameter is considered valid if the current value is
between the upper and lower bound. The message is used to
return the reason that the parameter is invalid. This function also
sets the CapeValidationStatus of the parameter based upon the results
of the validation.
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 is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument. |