DistributedCacheExtensions.GetStringAsync 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.
Asynchronously gets a string from the specified cache with the specified key.
public static System.Threading.Tasks.Task<string?> GetStringAsync (this Microsoft.Extensions.Caching.Distributed.IDistributedCache cache, string key, System.Threading.CancellationToken token = default);static member GetStringAsync : Microsoft.Extensions.Caching.Distributed.IDistributedCache * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string><Extension()>
Public Function GetStringAsync (cache As IDistributedCache, key As String, Optional token As CancellationToken = Nothing) As Task(Of String)Parameters
- cache
- IDistributedCache
The cache in which to store the data.
- key
- String
The key to get the stored data for.
- token
- CancellationToken
Optional. A CancellationToken to cancel the operation.
Returns
A task that gets the string value from the stored cache key.
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 GetString(IDistributedCache, String).
