Boolean
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
- The message is used to return the reason that the parameter is invalid.
Return Value
BooleanTrue if the parameter is valid, false if not valid.
Implements
ICapeParameterValidate(String)ICapeParameterValidate(String)
Remarks
This method checks the current value of the parameter to determine if it is an allowed value. Any valid boolean value (true/false)
valid for the ICapeBooleanParameterSpec paramaters.
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. |