This documentation is archived and is not being maintained.

Queue.Peek Method

Returns the object at the beginning of the Queue 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 beginning of the Queue.

ExceptionCondition
InvalidOperationException

The Queue is empty.

This method is similar to the Dequeue method, but Peek does not modify the Queue.

a null reference (Nothing in Visual Basic) can be added to the Queue as a value. To distinguish between a null value and the end of the Queue, check the Count property or catch the InvalidOperationException, which is thrown when the Queue is empty.

This method is an O(1) operation.

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

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: