CancellationTokenSource.Dispose Method

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Releases all resources used by the current instance of the CancellationTokenSource class.

Overloads

Dispose()	Releases all resources used by the current instance of the CancellationTokenSource class.
Dispose(Boolean)	Releases the unmanaged resources used by the CancellationTokenSource class and optionally releases the managed resources.

Dispose()

Source:

CancellationTokenSource.cs

Releases all resources used by the current instance of the CancellationTokenSource class.

public:
 virtual void Dispose();

public void Dispose ();

abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit

Public Sub Dispose ()

Implements

Dispose()

Remarks

Call Dispose when you are finished using the CancellationTokenSource. The Dispose method leaves the CancellationTokenSource in an unusable state. After calling Dispose, you must release all references to the CancellationTokenSource so the garbage collector can reclaim the memory that the CancellationTokenSource was occupying.

Note that calling Dispose does not communicate a request for cancellation to consumers of the associated Token. You can communicate a request for cancellation by calling methods such as Cancel or CancelAfter.

For more information, see Cleaning Up Unmanaged Resources and Implementing a Dispose Method.

Note

Always call Dispose before you release your last reference to the CancellationTokenSource. Otherwise, the resources it is using will not be freed until the garbage collector calls the CancellationTokenSource object's Finalize method.

Dispose(Boolean)

Source:

CancellationTokenSource.cs

Releases the unmanaged resources used by the CancellationTokenSource class and optionally releases the managed resources.

protected:
 virtual void Dispose(bool disposing);

protected virtual void Dispose (bool disposing);

abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit

Protected Overridable Sub Dispose (disposing As Boolean)

Parameters

disposing

Boolean

true to release both managed and unmanaged resources; false to release only unmanaged resources.