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

Exceptions

Exception Condition
InvalidOperationException

The Queue is empty.

Remarks

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

null Nothing nullptr unit 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.

.NET Framework Security

See Also

Reference

Queue Class

System.Collections Namespace