IDistributedCache.RemoveAsync 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.
Overloads
RemoveAsync(String) | |
RemoveAsync(String, CancellationToken) |
Removes the value with the given key. |
RemoveAsync(String)
public:
System::Threading::Tasks::Task ^ RemoveAsync(System::String ^ key);
public System.Threading.Tasks.Task RemoveAsync (string key);
abstract member RemoveAsync : string -> System.Threading.Tasks.Task
Public Function RemoveAsync (key As String) As Task
Parameters
- key
- String
Returns
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
RemoveAsync(String, CancellationToken)
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.
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).