Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Task.IsCanceled Property
Definition
- Namespace:
- System.Threading.Tasks
- Assemblies:
- mscorlib.dll, System.Threading.Tasks.dll
- Assemblies:
- netstandard.dll, System.Runtime.dll
- Assembly:
- System.Threading.Tasks.dll
- Assembly:
- System.Runtime.dll
- Assembly:
- mscorlib.dll
- Assembly:
- netstandard.dll
- Source:
- Task.cs
- Source:
- Task.cs
- Source:
- Task.cs
- Source:
- Task.cs
- Source:
- Task.cs
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.
Gets whether this Task instance has completed execution due to being canceled.
public:
property bool IsCanceled { bool get(); };public bool IsCanceled { get; }member this.IsCanceled : boolPublic ReadOnly Property IsCanceled As BooleanProperty Value
true if the task has completed due to being canceled; otherwise false.
Remarks
A Task will complete in the Canceled state under any of the following conditions:
Its CancellationToken was marked for cancellation before the task started executing,
The task acknowledged the cancellation request on its already signaled CancellationToken by throwing an OperationCanceledException that bears the same CancellationToken.
The task acknowledged the cancellation request on its already signaled CancellationToken by calling the ThrowIfCancellationRequested method on the CancellationToken.
Important
Retrieving the value of the IsCanceled property does not block the calling thread until the task has completed.
Applies to
Feedback
Was this page helpful?