Function Stack Class

RollDown

Roll the top N stack items down towards the stack bottom. Item previously at position Top - N + 1 ends up on the top of the stack. Function returns True upon success and False upon failure.

Signature (Visual Basic / VBA)

Public Function RollDown( _
    ByVal vPosits As Long _
    ) As Boolean

Code Example

    Assuming
       stkTemp.StringView() = "(Top) 4, 3, 2, 1 (Bottom)"
    for example
       stkTemp.RollDown(3) = True
    leaves
       stkTemp.StringView() = "(Top) 2, 4, 3, 1 (Bottom)"

Parameters

Parameter Description
vPosits The number of stack items that are to be rotated downwards. The function does nothing and returns False if there are fewer than vPosits items on the stack.

Notes & Version History

v1.3 BugFix This Function has been fixed to support the RollDown of elements from Stacks containing Object and/or DataObject type Values.