TaskCompletionSource(Of TResult).TrySetCanceled Method

Attempts to transition the underlying Task(Of TResult) into the Canceled state.

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

'Declaration
Public Function TrySetCanceled As Boolean

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(Of TResult) is already in one of the three final states: RanToCompletion, Faulted, or Canceled.

This method also returns false if the underlying Task(Of TResult) has already been disposed.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft