mscorlib(4.0.0.0) API with additions
System.OperationCanceledException Class Reference

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

Inheritance diagram for System.OperationCanceledException:
[legend]
Collaboration diagram for System.OperationCanceledException:
[legend]

Public Member Functions

 OperationCanceledException ()
 Initializes a new instance of the T:System.OperationCanceledException class with a system-supplied error message. More...
 
 OperationCanceledException (string message)
 Initializes a new instance of the T:System.OperationCanceledException class with a specified error message. More...
 
 OperationCanceledException (string message, Exception innerException)
 Initializes a new instance of the T:System.OperationCanceledException class with a specified error message and a reference to the inner exception that is the cause of this exception. More...
 
 OperationCanceledException (CancellationToken token)
 Initializes a new instance of the T:System.OperationCanceledException class with a cancellation token. More...
 
 OperationCanceledException (string message, CancellationToken token)
 Initializes a new instance of the T:System.OperationCanceledException class with a specified error message and a cancellation token. More...
 
 OperationCanceledException (string message, Exception innerException, CancellationToken token)
 Initializes a new instance of the T:System.OperationCanceledException class with a specified error message, a reference to the inner exception that is the cause of this exception, and a cancellation token. More...
 
- Public Member Functions inherited from System.SystemException
 SystemException ()
 Initializes a new instance of the T:System.SystemException class. More...
 
 SystemException (string message)
 Initializes a new instance of the T:System.SystemException class with a specified error message. More...
 
 SystemException (string message, Exception innerException)
 Initializes a new instance of the T:System.SystemException class with a specified error message and a reference to the inner exception that is the cause of this exception. More...
 
- Public Member Functions inherited from System.Exception
 Exception ()
 Initializes a new instance of the T:System.Exception class. More...
 
 Exception (string message)
 Initializes a new instance of the T:System.Exception class with a specified error message. More...
 
 Exception (string message, Exception innerException)
 Initializes a new instance of the T:System.Exception class with a specified error message and a reference to the inner exception that is the cause of this exception. More...
 
virtual Exception GetBaseException ()
 When overridden in a derived class, returns the T:System.Exception that is the root cause of one or more subsequent exceptions. More...
 
override string ToString ()
 Creates and returns a string representation of the current exception. More...
 
virtual void GetObjectData (SerializationInfo info, StreamingContext context)
 When overridden in a derived class, sets the T:System.Runtime.Serialization.SerializationInfo with information about the exception. More...
 
new Type GetType ()
 Gets the runtime type of the current instance. More...
 
- Public Member Functions inherited from System.Runtime.InteropServices._Exception
new bool Equals (object obj)
 Provides COM objects with version-independent access to the M:System.Object.Equals(System.Object) method. More...
 
new int GetHashCode ()
 Provides COM objects with version-independent access to the M:System.Object.GetHashCode method. More...
 

Protected Member Functions

 OperationCanceledException (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the T:System.OperationCanceledException class with serialized data. More...
 
- Protected Member Functions inherited from System.SystemException
 SystemException (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the T:System.SystemException class with serialized data. More...
 
- Protected Member Functions inherited from System.Exception
 Exception (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the T:System.Exception class with serialized data. More...
 

Properties

CancellationToken CancellationToken [get]
 Gets a token associated with the operation that was canceled. More...
 
- Properties inherited from System.Exception
virtual string Message [get]
 Gets a message that describes the current exception. More...
 
virtual IDictionary Data [get]
 Gets a collection of key/value pairs that provide additional user-defined information about the exception. More...
 
Exception InnerException [get]
 Gets the T:System.Exception instance that caused the current exception. More...
 
MethodBase TargetSite [get]
 Gets the method that throws the current exception. More...
 
virtual string StackTrace [get]
 Gets a string representation of the immediate frames on the call stack. More...
 
virtual string HelpLink [get, set]
 Gets or sets a link to the help file associated with this exception. More...
 
virtual string Source [get, set]
 Gets or sets the name of the application or the object that causes the error. More...
 
int HResult [get, protected set]
 Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. More...
 
EventHandler< SafeSerializationEventArgsSerializeObjectState
 Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. More...
 
- Properties inherited from System.Runtime.InteropServices._Exception
string Message [get]
 Provides COM objects with version-independent access to the P:System.Exception.Message property. More...
 
string StackTrace [get]
 Provides COM objects with version-independent access to the P:System.Exception.StackTrace property. More...
 
string HelpLink [get, set]
 Provides COM objects with version-independent access to the P:System.Exception.HelpLink property. More...
 
string Source [get, set]
 Provides COM objects with version-independent access to the P:System.Exception.Source property. More...
 
Exception InnerException [get]
 Provides COM objects with version-independent access to the P:System.Exception.InnerException property. More...
 
MethodBase TargetSite [get]
 Provides COM objects with version-independent access to the P:System.Exception.TargetSite property. More...
 

Detailed Description

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

Definition at line 11 of file OperationCanceledException.cs.

Constructor & Destructor Documentation

◆ OperationCanceledException() [1/7]

System.OperationCanceledException.OperationCanceledException ( )

Initializes a new instance of the T:System.OperationCanceledException class with a system-supplied error message.

Definition at line 34 of file OperationCanceledException.cs.

◆ OperationCanceledException() [2/7]

System.OperationCanceledException.OperationCanceledException ( string  message)

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

Parameters
messageA T:System.String that describes the error.

Definition at line 43 of file OperationCanceledException.cs.

◆ OperationCanceledException() [3/7]

System.OperationCanceledException.OperationCanceledException ( string  message,
Exception  innerException 
)

Initializes a new instance of the T:System.OperationCanceledException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters
messageThe error message that explains the reason for the exception.
innerExceptionThe exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.

Definition at line 53 of file OperationCanceledException.cs.

◆ OperationCanceledException() [4/7]

System.OperationCanceledException.OperationCanceledException ( CancellationToken  token)

Initializes a new instance of the T:System.OperationCanceledException class with a cancellation token.

Parameters
tokenA cancellation token associated with the operation that was canceled.

Definition at line 62 of file OperationCanceledException.cs.

◆ OperationCanceledException() [5/7]

System.OperationCanceledException.OperationCanceledException ( string  message,
CancellationToken  token 
)

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

Parameters
messageThe error message that explains the reason for the exception.
tokenA cancellation token associated with the operation that was canceled.

Definition at line 72 of file OperationCanceledException.cs.

◆ OperationCanceledException() [6/7]

System.OperationCanceledException.OperationCanceledException ( string  message,
Exception  innerException,
CancellationToken  token 
)

Initializes a new instance of the T:System.OperationCanceledException class with a specified error message, a reference to the inner exception that is the cause of this exception, and a cancellation token.

Parameters
messageThe error message that explains the reason for the exception.
innerExceptionThe exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
tokenA cancellation token associated with the operation that was canceled.

Definition at line 83 of file OperationCanceledException.cs.

◆ OperationCanceledException() [7/7]

System.OperationCanceledException.OperationCanceledException ( SerializationInfo  info,
StreamingContext  context 
)
protected

Initializes a new instance of the T:System.OperationCanceledException class with serialized data.

Parameters
infoThe object that holds the serialized object data.
contextThe contextual information about the source or destination.

Definition at line 92 of file OperationCanceledException.cs.

Property Documentation

◆ CancellationToken

CancellationToken System.OperationCanceledException.CancellationToken
get

Gets a token associated with the operation that was canceled.

Returns
A token associated with the operation that was canceled, or a default token.

Definition at line 20 of file OperationCanceledException.cs.


The documentation for this class was generated from the following file: