Edit

Share via

TaskCompletionSource<TResult>.SetCanceled Method

  • Reference

Definition

Namespace:
System.Threading.Tasks
Assemblies:
mscorlib.dll, System.Threading.Tasks.dll
Assemblies:
netstandard.dll, System.Runtime.dll
Assembly:
System.Threading.Tasks.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Overloads

SetCanceled()

Transitions the underlying Task<TResult> into the Canceled state.
SetCanceled(CancellationToken)

Transitions the underlying Task<TResult> into the Canceled state using the specified token.

SetCanceled()

Source:
TaskCompletionSource_T.cs
Source:
TaskCompletionSource_T.cs
Source:
TaskCompletionSource_T.cs

Transitions the underlying Task<TResult> into the Canceled state.

C# 
public void SetCanceled();

Exceptions

InvalidOperationException

The underlying Task<TResult> is already in one of the three final states: RanToCompletion, Faulted, or Canceled, or if the underlying Task<TResult> has already been disposed.

ObjectDisposedException

The Task was disposed.

See also

Applies to

.NET 10 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, 10
.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

SetCanceled(CancellationToken)

Source:
TaskCompletionSource_T.cs
Source:
TaskCompletionSource_T.cs
Source:
TaskCompletionSource_T.cs

Transitions the underlying Task<TResult> into the Canceled state using the specified token.

C# 
public void SetCanceled(System.Threading.CancellationToken cancellationToken);

Parameters

cancellationToken
CancellationToken

The cancellation token with which to cancel the Task<TResult>.

Exceptions

InvalidOperationException

The underlying Task<TResult> is already in one of the three final states: RanToCompletion, Faulted, or Canceled.

Applies to

.NET 10 and other versions
Product Versions
.NET 5, 6, 7, 8, 9, 10