Edit

Share via


OperationCanceledException Class

Definition

The exception that is thrown in a thread upon cancellation of an operation that the thread was executing.

public class OperationCanceledException : Exception
public class OperationCanceledException : SystemException
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class OperationCanceledException : SystemException
Inheritance
OperationCanceledException
Inheritance
OperationCanceledException
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, CancellationToken)

Initializes a new instance of the OperationCanceledException class with a specified error message and a cancellation token.

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.

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)

Initializes a new instance of the OperationCanceledException class with a specified error message.

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

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also