This documentation is archived and is not being maintained.

TaskScheduler::TryDequeue Method

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

Namespace:  System.Threading.Tasks
Assembly:  mscorlib (in mscorlib.dll)

protected public:
virtual bool TryDequeue(
	Task^ task
)

Parameters

task
Type: System.Threading.Tasks::Task
The Task to be dequeued.

Return Value

Type: System::Boolean
A Boolean denoting whether the task argument was successfully dequeued.

ExceptionCondition
ArgumentNullException

The task argument is null.

For more information, see Task Schedulers.

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.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: