TaskScheduler::TryDequeue Method (Task^)

.NET Framework (current version)

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

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

Syntax

public protected:
[SecurityCriticalAttribute]
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.

Exceptions

Exception	Condition
ArgumentNullException	The task argument is null.

Remarks

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.

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1