TaskCanceledException Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of the TaskCanceledException class.
Overloads
TaskCanceledException() |
Initializes a new instance of the TaskCanceledException class with a system-supplied message that describes the error. |
TaskCanceledException(String) |
Initializes a new instance of the TaskCanceledException class with a specified message that describes the error. |
TaskCanceledException(Task) |
Initializes a new instance of the TaskCanceledException class with a reference to the Task that has been canceled. |
TaskCanceledException(SerializationInfo, StreamingContext) |
Obsolete.
Initializes a new instance of the TaskCanceledException class with serialized data. |
TaskCanceledException(String, Exception) |
Initializes a new instance of the TaskCanceledException class with a specified error message and a reference to the inner exception that is the cause of this exception. |
TaskCanceledException(String, Exception, CancellationToken) |
Initializes a new instance of the TaskCanceledException class with a specified error message, a reference to the inner exception that is the cause of this exception, and the CancellationToken that triggered the cancellation. |
TaskCanceledException()
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
Initializes a new instance of the TaskCanceledException class with a system-supplied message that describes the error.
public:
TaskCanceledException();
public TaskCanceledException ();
Public Sub New ()
Remarks
This constructor initializes the Message property of the new instance to a system-supplied message that describes the error. 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 | null . |
Message | The localized error message string. |
See also
- Handling and Throwing Exceptions
- Task-based Asynchronous Programming
- Task Cancellation
- How to: Cancel a Task and Its Children
Applies to
TaskCanceledException(String)
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
Initializes a new instance of the TaskCanceledException class with a specified message that describes the error.
public:
TaskCanceledException(System::String ^ message);
public TaskCanceledException (string message);
public TaskCanceledException (string? message);
new System.Threading.Tasks.TaskCanceledException : string -> System.Threading.Tasks.TaskCanceledException
Public Sub New (message As String)
Parameters
- message
- String
The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
Remarks
The following table shows the initial property values for an instance of TaskCanceledException.
Property | Value |
---|---|
InnerException | null . |
Message | The error message string specified in message . |
See also
- Handling and Throwing Exceptions
- Task-based Asynchronous Programming
- Task Cancellation
- How to: Cancel a Task and Its Children
Applies to
TaskCanceledException(Task)
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
Initializes a new instance of the TaskCanceledException class with a reference to the Task that has been canceled.
public:
TaskCanceledException(System::Threading::Tasks::Task ^ task);
public TaskCanceledException (System.Threading.Tasks.Task task);
public TaskCanceledException (System.Threading.Tasks.Task? task);
new System.Threading.Tasks.TaskCanceledException : System.Threading.Tasks.Task -> System.Threading.Tasks.TaskCanceledException
Public Sub New (task As Task)
Parameters
- task
- Task
A task that has been canceled.
See also
- Handling and Throwing Exceptions
- Task-based Asynchronous Programming
- Task Cancellation
- How to: Cancel a Task and Its Children
Applies to
TaskCanceledException(SerializationInfo, StreamingContext)
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.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 TaskCanceledException class with serialized data.
protected:
TaskCanceledException(System::Runtime::Serialization::SerializationInfo ^ info, System::Runtime::Serialization::StreamingContext context);
protected TaskCanceledException (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 TaskCanceledException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);
new System.Threading.Tasks.TaskCanceledException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> System.Threading.Tasks.TaskCanceledException
[<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 System.Threading.Tasks.TaskCanceledException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> System.Threading.Tasks.TaskCanceledException
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
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
- Handling and Throwing Exceptions
- Task-based Asynchronous Programming
- Task Cancellation
- How to: Cancel a Task and Its Children
- XML and SOAP Serialization
Applies to
TaskCanceledException(String, Exception)
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
Initializes a new instance of the TaskCanceledException class with a specified error message and a reference to the inner exception that is the cause of this exception.
public:
TaskCanceledException(System::String ^ message, Exception ^ innerException);
public TaskCanceledException (string message, Exception innerException);
public TaskCanceledException (string? message, Exception? innerException);
new System.Threading.Tasks.TaskCanceledException : string * Exception -> System.Threading.Tasks.TaskCanceledException
Public Sub New (message As String, innerException As Exception)
Parameters
- message
- String
The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture.
- 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
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 TaskCanceledException.
Property | Value |
---|---|
InnerException | null . |
Message | The error message string specified in message . |
See also
- Handling and Throwing Exceptions
- Task-based Asynchronous Programming
- Task Cancellation
- How to: Cancel a Task and Its Children
Applies to
TaskCanceledException(String, Exception, CancellationToken)
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
- Source:
- TaskCanceledException.cs
Initializes a new instance of the TaskCanceledException class with a specified error message, a reference to the inner exception that is the cause of this exception, and the CancellationToken that triggered the cancellation.
public:
TaskCanceledException(System::String ^ message, Exception ^ innerException, System::Threading::CancellationToken token);
public TaskCanceledException (string? message, Exception? innerException, System.Threading.CancellationToken token);
public TaskCanceledException (string message, Exception innerException, System.Threading.CancellationToken token);
new System.Threading.Tasks.TaskCanceledException : string * Exception * System.Threading.CancellationToken -> System.Threading.Tasks.TaskCanceledException
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.
- token
- CancellationToken
The cancellation token that triggered the cancellation.