Task.FromCanceled Method

Definition

Namespace:

System.Threading.Tasks

Assembly:

System.Runtime.dll

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

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

public:
 static System::Threading::Tasks::Task ^ FromCanceled(System::Threading::CancellationToken cancellationToken);

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

static member FromCanceled : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function FromCanceled (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken

CancellationToken

The cancellation token with which to complete the task.

Returns

Task

The canceled task.

Exceptions

ArgumentOutOfRangeException

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

FromCanceled<TResult>(CancellationToken)

Source:

Task.cs

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

public:
generic <typename TResult>
 static System::Threading::Tasks::Task<TResult> ^ FromCanceled(System::Threading::CancellationToken cancellationToken);

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

static member FromCanceled : System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>

Public Shared Function FromCanceled(Of TResult) (cancellationToken As CancellationToken) As Task(Of TResult)

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

Task<TResult>

The canceled task.

Exceptions

ArgumentOutOfRangeException

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