OperationCanceledException Constructors

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Initializes a new instance of the OperationCanceledException class.

Overloads

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

OperationCanceledException()

Source:

OperationCanceledException.cs

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

public:
 OperationCanceledException();

public OperationCanceledException ();

Public Sub New ()

Remarks

This constructor initializes the Message property of the new instance to a system-supplied message that describes the error, such as "The operation was canceled." This message takes into account the current system culture.

The following table shows the initial property values for an instance of OperationCanceledException.

Property	Value
InnerException	A nullreference (Nothing in Visual Basic).
Message	The localized error message string.
CancellationToken	A cancellation token created in the non-canceled state.

See also

• Exception
• Handling and Throwing Exceptions

OperationCanceledException(String)

Source:

OperationCanceledException.cs

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

public:
 OperationCanceledException(System::String ^ message);

public OperationCanceledException (string? message);

new OperationCanceledException : string -> OperationCanceledException

Public Sub New (message As String)

Parameters

message

String

A String that describes the error.

Remarks

The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

The following table shows the initial property values for an instance of OperationCanceledException.

Property	Value
InnerException	A null reference (Nothing in Visual Basic).
Message	The error message string.
CancellationToken	A cancellation token created in the non-canceled state.

See also

• Exception
• Handling and Throwing Exceptions

OperationCanceledException(CancellationToken)

Source:

OperationCanceledException.cs

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

public:
 OperationCanceledException(System::Threading::CancellationToken token);

public OperationCanceledException (System.Threading.CancellationToken token);

new OperationCanceledException : System.Threading.CancellationToken -> OperationCanceledException

Public Sub New (token As CancellationToken)

Parameters

token

CancellationToken

A cancellation token associated with the operation that was canceled.

Remarks

This constructor initializes the Message property of the new instance to a system-supplied message that describes the error, such as "The operation was canceled." This message takes into account the current system culture.

The following table shows the initial property values for an instance of OperationCanceledException.

Property	Value
InnerException	A nullreference (Nothing in Visual Basic).
Message	The localized error message string.
CancellationToken	token.

See also

• Exception
• Handling and Throwing Exceptions

OperationCanceledException(SerializationInfo, StreamingContext)

Source:

OperationCanceledException.cs

Caution

This API supports obsolete formatter-based serialization. It should not be called or extended by application code.

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

protected:
 OperationCanceledException(System::Runtime::Serialization::SerializationInfo ^ info, System::Runtime::Serialization::StreamingContext context);

[System.Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId="SYSLIB0051", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
protected OperationCanceledException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);

[<System.Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId="SYSLIB0051", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>]
new OperationCanceledException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> OperationCanceledException

Protected Sub New (info As SerializationInfo, context As StreamingContext)

Parameters

info

SerializationInfo

The object that holds the serialized object data.

context

StreamingContext

The contextual information about the source or destination.

Attributes

ObsoleteAttribute

Remarks

This constructor is called during deserialization to reconstitute the exception object transmitted over a stream. For more information, see XML and SOAP Serialization

See also

• XML and SOAP Serialization

OperationCanceledException(String, Exception)

Source:

OperationCanceledException.cs

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:
 OperationCanceledException(System::String ^ message, Exception ^ innerException);

public OperationCanceledException (string? message, Exception? innerException);

new OperationCanceledException : string * Exception -> OperationCanceledException

Public Sub New (message As String, innerException As Exception)

Parameters

message

String

The error message that explains the reason for the exception.

innerException

Exception

The 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.

Remarks

The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

An exception that is thrown as a direct result of a previous exception should include a reference to the previous exception in the InnerException property. The InnerException property returns the same value that is passed into the constructor, or null if the InnerException property does not supply the inner exception value to the constructor.

The following table shows the initial property values for an instance of OperationCanceledException.

Property Type	Condition
InnerException	innerException.
Message	message.
CancellationToken	A cancellation token created in the non-canceled state.

See also

• Exception
• Handling and Throwing Exceptions

OperationCanceledException(String, CancellationToken)

Source:

OperationCanceledException.cs

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

public:
 OperationCanceledException(System::String ^ message, System::Threading::CancellationToken token);

public OperationCanceledException (string? message, System.Threading.CancellationToken token);

new OperationCanceledException : string * System.Threading.CancellationToken -> OperationCanceledException

Public Sub New (message As String, token As CancellationToken)

Parameters

message

String

The error message that explains the reason for the exception.

token

CancellationToken

A cancellation token associated with the operation that was canceled.

Remarks

The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

The following table shows the initial property values for an instance of OperationCanceledException.

Property	Value
InnerException	A null reference (Nothing in Visual Basic).
Message	message.
CancellationToken	token.

See also

• Exception
• Handling and Throwing Exceptions

OperationCanceledException(String, Exception, CancellationToken)

Source:

OperationCanceledException.cs

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.

public:
 OperationCanceledException(System::String ^ message, Exception ^ innerException, System::Threading::CancellationToken token);

public OperationCanceledException (string? message, Exception? innerException, System.Threading.CancellationToken token);

new OperationCanceledException : string * Exception * System.Threading.CancellationToken -> OperationCanceledException

Public Sub New (message As String, innerException As Exception, token As CancellationToken)

Parameters

message

String

The error message that explains the reason for the exception.

innerException

Exception

The 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.

token

CancellationToken

A cancellation token associated with the operation that was canceled.

Remarks

The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.

An exception that is thrown as a direct result of a previous exception should include a reference to the previous exception in the InnerException property. The InnerException property returns the same value that is passed into the constructor, or null if the InnerException property does not supply the inner exception value to the constructor.

The following table shows the initial property values for an instance of OperationCanceledException.

Property Type	Condition
InnerException	innerException.
Message	message.
CancellationToken	token.

See also

• Exception
• Handling and Throwing Exceptions