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

Peek Function
Stack Class

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

Copy the value on the top of the stack into rValue,
without removing that value from the stack.
Function returns true upon success.

Example: 
    Assuming
       stkTemp.StringView() = "(Top) 4444, 333, 22, 1 (Bottom)"
       Dim varTemp As Variant
    for example
       stkTemp.Peek(varTemp) = True
    leaves
       varTemp = 4444
       stkTemp.StringView() = "(Top) 4444, 333, 22, 1 (Bottom)"
See also: 
    NthFromTop Property Get
    Item Property Get
    Pop Function
rValue: Value at the top of the Stack is assigned into variable rValue. rValue must be compatible with the value that is being retrieved from the Stack.
Return Value: Function returns True upon success and False upon failure (when the Stack is empty).
Note: Same as but faster than NthFromTop(1)
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.

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