• Article

OperationCanceledException Constructor (String, Exception, CancellationToken)

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

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)

Syntax

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

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 nulla null reference (Nothing in Visual Basic), 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 nulla null reference (Nothing in Visual Basic) 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.

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

Property Type

Condition

InnerException

innerException.

Message

message.

CancellationToken

token.

Version Information

Silverlight

Supported in: 5

Platforms

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