TaskCompletionSource<TResult>::TrySetCanceled Method (CancellationToken)

.NET Framework (current version)

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

Namespace: System.Threading.Tasks
Assembly: mscorlib (in mscorlib.dll)

Syntax

C++

public:
bool TrySetCanceled(
	CancellationToken cancellationToken
)

Parameters

cancellationToken: Type: System.Threading::CancellationToken
A cancellation token.

Return Value

Type: System::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.

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

Version Information

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.6