TaskCompletionSource<TResult>.SetCanceled Method

Definition

Namespace:

System.Threading.Tasks

Assembly:

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

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

public:
 void SetCanceled();

public void SetCanceled ();

member this.SetCanceled : unit -> unit

Public Sub 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

• TrySetCanceled()
• Using TPL with Other Asynchronous Patterns
• How to: Wrap EAP Patterns in a Task
• Task Cancellation

SetCanceled(CancellationToken)

Source:

TaskCompletionSource_T.cs

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

public:
 void SetCanceled(System::Threading::CancellationToken cancellationToken);

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

member this.SetCanceled : System.Threading.CancellationToken -> unit

Public Sub SetCanceled (cancellationToken As 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.