Function Deque Class

StackPop

Remove an item from the stack when the deque is being used as a stack. Same as RemoveHead .

Signature (Visual Basic / VBA)

Public Function StackPop( _
    ByRef rValue As Variant _
    ) As Boolean

Code Examples

    Assuming
       Dim dqTemp As New Deque
       dqTemp.StackPush 12
       dqTemp.StackPush 23
       Dim varTemp As Variant
       Dim bResult As Variant
    for example
       bResult = dqTemp.StackPop(varTemp)
    leaves
       bResult = True
       varTemp = 23
    and
       bResult = dqTemp.StackPop(varTemp)
    leaves
       bResult = True
       varTemp = 12
    StackPop = RemoveHead(rValue)

Parameters

Parameter Description
rValue Value at the top of the Stack is assigned into variable rValue. rValue must be compatible with the value that is being retrieved.

Return Value

Function returns True upon success and False upon failure (when the Stack / Deque is empty).

Notes & Version History

v1.3 BugFix This function has been changed to return the retrieved value via an argument instead of via its return value. This is so that you do not have to know in advance whether the function will return an object reference or an ordinary value. Also, this Function has been fixed to support the retrieval of Object and DataObject type Values.