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

Reference

Definition

Namespace:: System.Collections.Immutable

Assembly:: System.Collections.Immutable.dll

Package:: System.Collections.Immutable v8.0.0

Package:: System.Collections.Immutable v9.0.0-preview.3.24172.9

Source:: ImmutableInterlocked.cs

Source:: ImmutableInterlocked.cs

Source:: ImmutableInterlocked.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to