OperationCanceledException Class

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

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

Inheritance Hierarchy

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

'Declaration
<ComVisibleAttribute(True)> _
Public Class OperationCanceledException _
    Inherits SystemException

[ComVisibleAttribute(true)]
public class OperationCanceledException : SystemException

The OperationCanceledException type exposes the following members.

	Name	Description
	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(String)	Initializes a new instance of the OperationCanceledException class with a specified error message.
	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, 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.

Top

	Name	Description
	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.)
	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.)
	StackTrace	Gets a string representation of the frames on the call stack at the time the current exception was thrown. (Inherited from Exception.)

Top

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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.)
	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 a hash function for a particular type. (Inherited from Object.)
	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.)

Top

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.

Supported in: 5

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.