* * HELP & MANUAL PREMIUM PACK 4 DEMO VERSION * *
This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
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
