CancellationTokenRegistration.DisposeAsync Method

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Source:

CancellationTokenRegistration.cs

Disposes of the registration and unregisters the target callback from the associated CancellationToken.

public:
 virtual System::Threading::Tasks::ValueTask DisposeAsync();

public System.Threading.Tasks.ValueTask DisposeAsync ();

abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask

Public Function DisposeAsync () As ValueTask

Returns

ValueTask

A task that represents the asynchronous dispose operation.

Implements

DisposeAsync()

Remarks

The returned ValueTask completes once the associated callback is unregistered without having executed or once it's finished executing, except in the degenerate case where the callback is unregistering itself.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Dispose().