Partager via


TaskCanceledException Class

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

Represents an exception used to communicate task cancellation.

Inheritance Hierarchy

System.Object
  System.Exception
    System.SystemException
      System.OperationCanceledException
        System.Threading.Tasks.TaskCanceledException

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

Syntax

'Declaration
Public Class TaskCanceledException _
    Inherits OperationCanceledException
public class TaskCanceledException : OperationCanceledException

The TaskCanceledException type exposes the following members.

Constructors

  Name Description
Public method TaskCanceledException() Initializes a new instance of the TaskCanceledException class with a system-supplied message that describes the error.
Public method TaskCanceledException(String) Initializes a new instance of the TaskCanceledException class with a specified message that describes the error.
Public method TaskCanceledException(Task) Initializes a new instance of the TaskCanceledException class with a reference to the Task that has been canceled.
Public method TaskCanceledException(String, Exception) Initializes a new instance of the TaskCanceledException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Top

Properties

  Name Description
Public property CancellationToken Gets a token associated with the operation that was canceled. (Inherited from OperationCanceledException.)
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Protected property HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Message Gets a message that describes the current exception. (Inherited from Exception.)
Public property StackTrace Gets a string representation of the frames on the call stack at the time the current exception was thrown. (Inherited from Exception.)
Public property Task Gets the task associated with this exception.

Top

Methods

  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the runtime type of the current instance. (Inherited from Exception.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Creates and returns a string representation of the current exception. (Inherited from Exception.)

Top

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.

Thread Safety

The Task property is thread-safe and may be used from multiple threads concurrently.