Dequeue Method

Queue.Dequeue Method

Removes and returns the object at the beginning of the Queue.

Namespace: System.Collections.Generic
Assembly: System (in system.dll)

public:
T Dequeue ()
public T Dequeue ()
public function Dequeue () : T
Not applicable.

Return Value

The object that is removed from the beginning of the Queue.

Exception typeCondition

InvalidOperationException

The Queue is empty.

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

If type T is a reference type, a null reference (Nothing in Visual Basic) can be added to the Queue as a value.

This method is an O(1) operation.

The following code example demonstrates several methods of the Queue generic class, including the Dequeue method.

The code example creates a queue of strings with default capacity and uses the Enqueue method to queue five strings. The elements of the queue are enumerated, which does not change the state of the queue. The Dequeue method is used to dequeue the first string. The Peek method is used to look at the next item in the queue, and then the Dequeue method is used to dequeue it.

The ToArray method is used to create an array and copy the queue elements to it, then the array is passed to the Queue constructor that takes IEnumerable, creating a copy of the queue. The elements of the copy are displayed.

An array twice the size of the queue is created, and the CopyTo method is used to copy the array elements beginning at the middle of the array. The Queue constructor is used again to create a second copy of the queue containing three null elements at the beginning.

The Contains method is used to show that the string "four" is in the first copy of the queue, after which the Clear method clears the copy and the Count property shows that the queue is empty.

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2016 Microsoft