Export (0) Print
Expand All

Stack.Peek Method

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

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

abstract Peek : unit -> Object  
override Peek : unit -> Object

Return Value

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

ExceptionCondition
InvalidOperationException

The Stack is empty.

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

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.

The following example shows how to add elements to the Stack, remove elements from the Stack, or view the element at the top of the Stack.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft