ICapeOptionParameterSpecValidate Method

Validates the value against the parameter's specification.

Definition

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

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

VBRequest Example

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

Parameters

value String: A candidate value for the parameter to be tested to determine whether the value is valid.
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

If the value of the RestrictedToList is set to true, the value is valid is valid value for the parameter if it is included in the OptionList. If the value of RestrictedToList is false any valid String is a valid value for the parameter.

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.