OperationCanceledException Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The exception that is thrown in a thread upon cancellation of an operation that the thread was executing.
public ref class OperationCanceledException : Exception
public ref class OperationCanceledException : SystemException
public class OperationCanceledException : Exception
public class OperationCanceledException : SystemException
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class OperationCanceledException : SystemException
type OperationCanceledException = class
inherit Exception
type OperationCanceledException = class
inherit SystemException
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Serializable>]
type OperationCanceledException = class
inherit SystemException
Public Class OperationCanceledException
Inherits Exception
Public Class OperationCanceledException
Inherits SystemException
- Inheritance
- Inheritance
- Derived
- Attributes
Remarks
If the task that was canceled had an associated cancellation token, it is returned by the CancellationToken property, and the CancellationToken.IsCancellationRequested property of the token is set to true
.
Constructors
OperationCanceledException() |
Initializes a new instance of the OperationCanceledException class with a system-supplied error message. |
OperationCanceledException(CancellationToken) |
Initializes a new instance of the OperationCanceledException class with a cancellation token. |
OperationCanceledException(SerializationInfo, StreamingContext) |
Obsolete.
Initializes a new instance of the OperationCanceledException class with serialized data. |
OperationCanceledException(String) |
Initializes a new instance of the OperationCanceledException class with a specified error message. |
OperationCanceledException(String, CancellationToken) |
Initializes a new instance of the OperationCanceledException class with a specified error message and a cancellation token. |
OperationCanceledException(String, Exception) |
Initializes a new instance of the OperationCanceledException class with a specified error message and a reference to the inner exception that is the cause of this exception. |
OperationCanceledException(String, Exception, CancellationToken) |
Initializes a new instance of the OperationCanceledException class with a specified error message, a reference to the inner exception that is the cause of this exception, and a cancellation token. |
Properties
CancellationToken |
Gets a token associated with the operation that was canceled. |
Data |
Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception) |
HelpLink |
Gets or sets a link to the help file associated with this exception. (Inherited from Exception) |
HResult |
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception) |
InnerException |
Gets the Exception instance that caused the current exception. (Inherited from Exception) |
Message |
Gets a message that describes the current exception. (Inherited from Exception) |
Source |
Gets or sets the name of the application or the object that causes the error. (Inherited from Exception) |
StackTrace |
Gets a string representation of the immediate frames on the call stack. (Inherited from Exception) |
TargetSite |
Gets the method that throws the current exception. (Inherited from Exception) |
Methods
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetBaseException() |
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception) |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetObjectData(SerializationInfo, StreamingContext) |
Obsolete.
When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception) |
GetType() |
Gets the runtime type of the current instance. (Inherited from Exception) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
ToString() |
Creates and returns a string representation of the current exception. (Inherited from Exception) |
Events
SerializeObjectState |
Obsolete.
Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception) |
Applies to
See also
.NET