The RANGE_LIMIT function constrains a given numeric parameter to within a range of values, returning a value that is no greater than or less than a given set of upper and lower limits. The function takes three parameters: the value to be constrained; a lower limit; and an upper limit. If the value to be constrained is greater than the lower limit and less than the upper limit, the function will return the value. If this value is less than the lower limit, the value of the lower limit will be returned. If the constrained value is greater then the upper limit, the upper limit value will be returned. Each of the three parameters are evaluated as either decimal or integral numbers, matching the context of the function call.
@RANGE_LIMIT (Constrain, Limit 1, Limit 2) | |
---|---|
Constrain | Required parameter; evaluated as either an integral or decimal
number matching the context of the function call. Contains the value
to be constrained by the function. This value will be returned if
it is between the values of the Limit 1 and Limit
2 parameters. |
Limit 1 | Required parameter; evaluated as either an integral or decimal
number matching the context of the function call. Contains the first
limiting value in the range to which Constrain will be
limited. This may be either the minimum or maximum value to which
the return value is to be constrained. |
Limit 2 | Required parameter; evaluated as either an integral or decimal
number matching the context of the function call. Contains the second
limiting value in the range to which Constrain will
be limited. This may be either the minimum or maximum value to which
the return value is to be constrained. |