CYCLE_PREV

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Core Language > BuiltIn Functions > Numeric functions >

CYCLE_PREV

 

Description

 

Returns the previous valid number in a number range.

If previous number is less than the min allowed number, the maximum range is returned.

 

Syntax

 

nPrev = CYCLE_Prev(CurrentValue, MinValue, MaxValue [, Increment])

 

Returns

 

Number

The previous available number

 

Parameters

 

Name

Type

Optional

Meaning

CurrentValue

Numeric

No

Current numeric value to be incremented

MinValue

Numeric

No

Minimum value range allowed

MaxValue

Numeric

No

Maximum value range allowed

Increment

Numeric

Yes

Value by which to increment CurrentValue. If omitted 1 will be used instead

 

Remarks

 

If (CurrentValue + Increment) is less than MinValue, MaxValue will be returned instead.

 

Restrictions

 

MaxValue must be greater then MinValue

 

See also

 

Examples