Task.FromCanceled Method

Definition

Overloads

FromCanceled(CancellationToken)

Creates a Task that's completed due to cancellation with a specified cancellation token.

FromCanceled<TResult>(CancellationToken)

Creates a Task<TResult> that's completed due to cancellation with a specified cancellation token.

FromCanceled(CancellationToken)

Source:
Task.cs
Source:
Task.cs
Source:
Task.cs

Creates a Task that's completed due to cancellation with a specified cancellation token.

C#
public static System.Threading.Tasks.Task FromCanceled(System.Threading.CancellationToken cancellationToken);

Parameters

cancellationToken
CancellationToken

The cancellation token with which to complete the task.

Returns

The canceled task.

Exceptions

Cancellation has not been requested for cancellationToken; its IsCancellationRequested property is false.

Applies to

.NET 9 and other versions
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.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

FromCanceled<TResult>(CancellationToken)

Source:
Task.cs
Source:
Task.cs
Source:
Task.cs

Creates a Task<TResult> that's completed due to cancellation with a specified cancellation token.

C#
public static System.Threading.Tasks.Task<TResult> FromCanceled<TResult>(System.Threading.CancellationToken cancellationToken);

Type Parameters

TResult

The type of the result returned by the task.

Parameters

cancellationToken
CancellationToken

The cancellation token with which to complete the task.

Returns

The canceled task.

Exceptions

Cancellation has not been requested for cancellationToken; its IsCancellationRequested property is false.

Applies to

.NET 9 and other versions
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.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0