ICapeBooleanParameterSpecValidate Method

Validates the value sent against the specification of the parameter.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

[DispIdAttribute(2)]
bool Validate(
	bool value,
	ref string message
)

VBRequest Example

<DispIdAttribute(2)>
Function Validate ( 
	value As Boolean,
	ByRef message As String
) As Boolean

Parameters

value Boolean: Boolean value that will be validated against the parameter's current specification.
message String: Reference to a string that will conain a message regarding the validation of the parameter.

Return Value

Boolean
True if the parameter is valid, false if not valid.

Remarks

Validates whether the argument is accepted by the parameter as a valid value. It returns a flag to indicate the success or failure of the validation together with a text message which can be used to convey the reasoning to the client/user.

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.