This documentation is archived and is not being maintained.
Recommended Version

OperationCanceledException Class

Visual Studio 2010

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

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

C#
C++
F#
VB
Copy 
'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public Class OperationCanceledException _
	Inherits SystemException

The OperationCanceledException type exposes the following members.

  NameDescription
Public methodOperationCanceledExceptionInitializes a new instance of the OperationCanceledException class with a system-supplied error message.
Public methodOperationCanceledException(CancellationToken)Initializes a new instance of the OperationCanceledException class with a cancellation token.
Public methodOperationCanceledException(String)Initializes a new instance of the OperationCanceledException class with a specified error message.
Protected methodOperationCanceledException(SerializationInfo, StreamingContext)Initializes a new instance of the OperationCanceledException class with serialized data.
Public methodOperationCanceledException(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.
Public methodOperationCanceledException(String, CancellationToken)Initializes a new instance of the OperationCanceledException class with a specified error message and a cancellation token.
Public methodOperationCanceledException(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

  NameDescription
Public propertyCancellationTokenGets a token associated with the operation that was canceled.
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Protected propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyMessageGets a message that describes the current exception. (Inherited from Exception.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetObjectDataWhen overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top

  NameDescription
Protected eventSerializeObjectStateOccurs when an exception is serialized to create an exception state object that contains serialized data about the 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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.

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