CYCLE_NEXT

<< Click to Display Table of Contents >>

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

CYCLE_NEXT

 

Description

 

Returns the next valid number in a number range.

If next number is greater than the max allowed number, the minimum range is returned.

 

Syntax

 

nNext = CYCLE_Next(CurrentValue, MinValue, MaxValue [, Increment])

 

Returns

 

Number

The next 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 greater than MaxValue, MinValue will be returned instead.

 

Restrictions

 

MaxValue must be greater then MinValue

 

See also

 

Examples