TaskCompletionSource<TResult>.TrySetCanceled Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public bool TrySetCanceled()

Return Value

Type: System.Boolean

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

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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: