ImmutableInterlocked.TryDequeue<T>(ImmutableQueue<T>, T) Method

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Source:

ImmutableInterlocked.cs

Atomically removes and returns the specified element at the head of the queue, if the queue is not empty.

public:
generic <typename T>
 static bool TryDequeue(System::Collections::Immutable::ImmutableQueue<T> ^ % location, [Runtime::InteropServices::Out] T % value);

public static bool TryDequeue<T> (ref System.Collections.Immutable.ImmutableQueue<T> location, out T value);

static member TryDequeue : ImmutableQueue * 'T -> bool

Public Shared Function TryDequeue(Of T) (ByRef location As ImmutableQueue(Of T), ByRef value As T) As Boolean

Type Parameters

T

The type of items in the queue.

Parameters

location

ImmutableQueue<T>

The variable or field to atomically update.

value

T

Set to the value from the head of the queue, if the queue not empty.

Returns

Boolean

true if the queue is not empty and the head element is removed; otherwise, false.