OptionParameterValidate(String) Method

Validates the current value of the parameter against the parameter's specification.

Definition

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

public override bool Validate(
	ref string message
)

VBRequest Example

Public Overrides Function Validate ( 
	ByRef message As String
) As Boolean

Parameters

message String: Reference to a string that will conain a message regarding the validation of the parameter.

Return Value

Boolean
True if the string argument is valid, false if it is not.

Implements

ICapeParameterValidate(String)
ICapeParameterValidate(String)

Remarks

If the value of the RestrictedToList public is set to true, the parameter is valid only if the current value is included in the OptionList. If the value of RestrictedToList public 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.