Queue.Peek Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

Exception Condition
InvalidOperationException

The Queue is empty.

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

null 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.

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top
Show: