This topic has not yet been rated - Rate this topic

TaskCanceledException Class

Represents an exception used to communicate task cancellation.

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

Namespace:  System.Threading.Tasks
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
public class TaskCanceledException : OperationCanceledException

The TaskCanceledException type exposes the following members.

  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.
Protected method TaskCanceledException(SerializationInfo, StreamingContext) Initializes a new instance of the TaskCanceledException class with serialized data.
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
  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.)
Public property HelpLink Gets or sets a link to the help file associated with this 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 Source Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)
Public property Task Gets the task associated with this exception.
Top
  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 it 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 GetObjectData When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)
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
  Name Description
Protected event SerializeObjectState Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ