Share via


Peek Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Returns the object at the top of the Stack without removing it.

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Overridable Function Peek As Object
public virtual Object Peek()
public:
virtual Object^ Peek()
abstract Peek : unit -> Object 
override Peek : unit -> Object 
public function Peek() : Object

Return Value

Type: System. . :: . .Object
The Object at the top of the Stack.

Exceptions

Exception Condition
InvalidOperationException

The Stack is empty.

Remarks

This method is similar to the Pop method, but Peek does not modify the Stack.

null Nothing nullptr unit a null reference (Nothing in Visual Basic) can be pushed onto the Stack as a placeholder, if needed. To distinguish between a null value and the end of the stack, check the Count property or catch the InvalidOperationException, which is thrown when the Stack is empty.

This method is an O(1) operation.

.NET Framework Security

See Also

Reference

Stack Class

System.Collections Namespace