OperationCanceledException Constructor (String, Exception, CancellationToken)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

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

public OperationCanceledException(
	string message,
	Exception innerException,
	CancellationToken token
)

Parameters

message
Type: System.String

The error message that explains the reason for the exception.

innerException
Type: System.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
Type: System.Threading.CancellationToken

A cancellation token associated with the operation that was canceled.

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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: