TaskCompletionSource<TResult>.TrySetCanceled Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public Function TrySetCanceled As Boolean
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.

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.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.