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

public bool Validate(
	double value,
	ref string message
)

VBRequest Example

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

Parameters

value Double: The name of the unit that the value should be converted to.
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.

Implements

ICapeRealParameterSpecValidate(Double, String)

Remarks

The value is considered valid if it is between the upper and lower bound of the parameter. 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.