TaskScheduler.TryExecuteTask(Task) Method

Definition

Attempts to execute the provided Task on this scheduler.

[System.Security.SecurityCritical]
protected bool TryExecuteTask (System.Threading.Tasks.Task task);
protected bool TryExecuteTask (System.Threading.Tasks.Task task);

Parameters

task
Task

A Task object to be executed.

Returns

A Boolean that is true if task was successfully executed, false if it was not. A common reason for execution failure is that the task had previously been executed or is in the process of being executed by another thread.

Attributes

Exceptions

The task is not associated with this scheduler.

Remarks

Scheduler implementations are provided with Task instances to be executed through either the QueueTask method or the TryExecuteTaskInline method. When the scheduler deems it appropriate to run the provided task, TryExecuteTask should be used to do so. TryExecuteTask handles all aspects of executing a task, including action invocation, exception handling, state management, and lifecycle control.

TryExecuteTask must only be used for tasks provided to this scheduler by the .NET Framework infrastructure. It should not be used to execute arbitrary tasks obtained through custom mechanisms.

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
.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