TaskScheduler.TryDequeue(Task) Method

Definition

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.

Attempts to dequeue a Task that was previously queued to this scheduler.

C#
[System.Security.SecurityCritical]
protected internal virtual bool TryDequeue(System.Threading.Tasks.Task task);
C#
protected internal virtual bool TryDequeue(System.Threading.Tasks.Task task);

Parameters

task
Task

The Task to be dequeued.

Returns

A Boolean denoting whether the task argument was successfully dequeued.

Attributes

Exceptions

The task argument is null.

Remarks

For more information, see TaskScheduler.

This method may execute in a finally block; therefore it should return as quickly as possible so that any resources such as CancellationTokenRegistration objects can be disposed of in a timely manner.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also