ICape
Validates the value against the specification of the parameter.
The message is used to return the reason that the parameter is invalid.
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.
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[DispIdAttribute(4)]
Object Validate(
Object inputArray,
ref Object value
)VB
<DispIdAttribute(4)>
Function Validate (
inputArray As Object,
ByRef value As Object
) As ObjectParameters
- inputArray Object
- The message is used to return the reason that the parameter is invalid.
- value Object
- A string array containing the message is used to return the reason that the parameter is invalid.
Return Value
ObjectTrue if the parameter is valid, false if not valid.
Remarks
This method checks the current value of the parameter to determine if it is an allowed value.
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. |