Task.FromCanceled Method
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.
FromCanceled(CancellationToken) |
Creates a Task that's completed due to cancellation with a specified cancellation token. |
FromCanceled<TResult>(CancellationToken) |
Creates a Task<TResult> that's completed due to cancellation with a specified cancellation token. |
- Source:
- Task.cs
- Source:
- Task.cs
- Source:
- Task.cs
Creates a Task that's completed due to cancellation with a specified cancellation token.
public:
static System::Threading::Tasks::Task ^ FromCanceled(System::Threading::CancellationToken cancellationToken);
public static System.Threading.Tasks.Task FromCanceled(System.Threading.CancellationToken cancellationToken);
static member FromCanceled : System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function FromCanceled (cancellationToken As CancellationToken) As Task
Parameters
- cancellationToken
- CancellationToken
The cancellation token with which to complete the task.
Returns
The canceled task.
Exceptions
Cancellation has not been requested for cancellationToken
; its IsCancellationRequested property is false
.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.3, 1.4, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Task.cs
- Source:
- Task.cs
- Source:
- Task.cs
Creates a Task<TResult> that's completed due to cancellation with a specified cancellation token.
public:
generic <typename TResult>
static System::Threading::Tasks::Task<TResult> ^ FromCanceled(System::Threading::CancellationToken cancellationToken);
public static System.Threading.Tasks.Task<TResult> FromCanceled<TResult>(System.Threading.CancellationToken cancellationToken);
static member FromCanceled : System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>
Public Shared Function FromCanceled(Of TResult) (cancellationToken As CancellationToken) As Task(Of TResult)
Type Parameters
- TResult
The type of the result returned by the task.
Parameters
- cancellationToken
- CancellationToken
The cancellation token with which to complete the task.
Returns
The canceled task.
Exceptions
Cancellation has not been requested for cancellationToken
; its IsCancellationRequested property is false
.
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.3, 1.4, 1.6, 2.0, 2.1 |
UWP | 10.0 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: