MemoryDistributedCache.RemoveAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Extensions.Caching.Distributed

Assembly:

Microsoft.Extensions.Caching.Memory.dll

Package:

Microsoft.Extensions.Caching.Memory v9.0.0

Source:

MemoryDistributedCache.cs

Asynchronously removes the specified item associated with a key from the IMemoryCache.

public System.Threading.Tasks.Task RemoveAsync (string key, System.Threading.CancellationToken token = default);

abstract member RemoveAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RemoveAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function RemoveAsync (key As String, Optional token As CancellationToken = Nothing) As Task

Parameters

key

String

The key of the item to remove.

token

CancellationToken

The CancellationToken to use to cancel operation.

Returns

Task

The task for removing the specified key from the cache.

Implements

RemoveAsync(String, CancellationToken)

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

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 Remove(String).