ICapeRealParameterSpecValidate Method

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)

C#Request Example

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

VBRequest Example

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

Parameters

value Double: Integer 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

The parameter is considered valid if the current value is between the upper and lower bound. The message is used to return the reason that the parameter is invalid.

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.