OptionParameterValidate(String, String) 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)

public bool Validate(
	string value,
	ref string message
)

VBRequest Example

Public Function Validate ( 
	value As String,
	ByRef message As String
) As Boolean

Parameters

value String: The string to be tested for validity.
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

ICapeOptionParameterSpecValidate(String, String)

Remarks

If the value of the RestrictedToList public is set to true, the value to be tested is a valid value for the parameter if it 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.