TaskCompletionSource<TResult>.TrySetCanceled Method

Definition

Namespace:

System.Threading.Tasks

Assembly:

System.Runtime.dll

Attempts to transition the underlying Task<TResult> into the Canceled state.

Overloads

TrySetCanceled()	Attempts to transition the underlying Task<TResult> into the Canceled state.
TrySetCanceled(CancellationToken)	Attempts to transition the underlying Task<TResult> into the Canceled state and enables a cancellation token to be stored in the canceled task.

TrySetCanceled()

Source:

TaskCompletionSource_T.cs

Attempts to transition the underlying Task<TResult> into the Canceled state.

public:
 bool TrySetCanceled();

public bool TrySetCanceled ();

member this.TrySetCanceled : unit -> bool

Public Function TrySetCanceled () As Boolean

Returns

Boolean

true if the operation was successful; false if the operation was unsuccessful or the object has already been disposed.

Exceptions

ObjectDisposedException

The Task was disposed.

Remarks

This operation will return false if the Task<TResult> is already in one of the three final states: RanToCompletion, Faulted, or Canceled.

This method also returns false if the underlying Task<TResult> has already been disposed.

See also

• Using TPL with Other Asynchronous Patterns
• How to: Wrap EAP Patterns in a Task

TrySetCanceled(CancellationToken)

Source:

TaskCompletionSource_T.cs

Attempts to transition the underlying Task<TResult> into the Canceled state and enables a cancellation token to be stored in the canceled task.

public:
 bool TrySetCanceled(System::Threading::CancellationToken cancellationToken);

public bool TrySetCanceled (System.Threading.CancellationToken cancellationToken);

member this.TrySetCanceled : System.Threading.CancellationToken -> bool

Public Function TrySetCanceled (cancellationToken As CancellationToken) As Boolean

Parameters

cancellationToken

CancellationToken

A cancellation token.

Returns

Boolean

true if the operation is successful; otherwise, false.

Remarks

The method returns false if the underlying Task<TResult> object is already in one of the following three final states.

• TaskStatus.Canceled

• TaskStatus.Faulted

• TaskStatus.RanToCompletion

This method also returns false if the underlying Task<TResult> object has already been disposed.