<-- Previous || Up || Next -->

Rotate Function
Stack Class

Public Function Rotate( _
    ) As Boolean

Rotate down the top THREE items on the stack.
Item previously at position Top - 2 ends up on the top of the stack.
Function returns True upon success and False upon failure.

Example: 
    Assuming
       stkTemp.StringView() = "(Top) 4, 3, 2, 1 (Bottom)"
    for example
       stkTemp.Rotate() = True
    leaves
       stkTemp.StringView() = "(Top) 2, 4, 3, 1 (Bottom)"
See also: 
    RollDown Function
    Swap Function
Return value: Function returns True upon success. The function does nothing and returns False if there are fewer than three items on the stack.
Note: Same as but faster than RollDown(3)
v1.3 BugFix: This Function has been fixed to support the Rotation of elements from Stacks containing Object and/or DataObject type Values.

Copyright 1996-1999 Entisoft
Entisoft Tools is a trademark of Entisoft.