Task.Dispose Method
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.
Releases all resources used by the current instance of the Task class.
Overloads
| Dispose(Boolean) |
Disposes the Task, releasing all of its unmanaged resources. |
| Dispose() |
Releases all resources used by the current instance of the Task class. |
Dispose(Boolean)
- Source:
- Task.cs
- Source:
- Task.cs
- Source:
- Task.cs
Disposes the Task, releasing all of its unmanaged resources.
protected:
virtual void Dispose(bool disposing);protected virtual void Dispose (bool disposing);abstract member Dispose : bool -> unit
override this.Dispose : bool -> unitProtected Overridable Sub Dispose (disposing As Boolean)Parameters
- disposing
- Boolean
A Boolean value that indicates whether this method is being called due to a call to Dispose().
Exceptions
The task is not in one of the final states: RanToCompletion, Faulted, or Canceled.
Remarks
The Task class implements the IDisposable interface because internally it uses resources that also implement IDisposable. However, particularly if your app targets the .NET Framework 4.5 or later, there is no need to call Dispose unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see Do I need to dispose of Tasks? in the Parallel Programming with .NET blog.
Thread Safety
Unlike most of the members of the Task class, this method is not thread-safe.
Applies to
Dispose()
- Source:
- Task.cs
- Source:
- Task.cs
- Source:
- Task.cs
Releases all resources used by the current instance of the Task class.
public:
virtual void Dispose();public void Dispose ();abstract member Dispose : unit -> unit
override this.Dispose : unit -> unitPublic Sub Dispose ()Implements
Exceptions
The task is not in one of the final states: RanToCompletion, Faulted, or Canceled.
Remarks
The Task class implements the IDisposable interface because internally it uses resources that also implement IDisposable. However, particularly if your app targets the .NET Framework 4.5 or later, there is no need to call Dispose unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see Do I need to dispose of Tasks? in the Parallel Programming with .NET blog.
