IDistributedCache.RemoveAsync(String, CancellationToken) Method

Definition

Removes the value with the given key.

public System.Threading.Tasks.Task RemoveAsync (string key, System.Threading.CancellationToken token = default);
abstract member 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

A string identifying the requested value.

token
CancellationToken

Optional. The CancellationToken used to propagate notifications that the operation should be canceled.

Returns

The Task that represents the asynchronous operation.

Exceptions

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).

Applies to