DistributedCacheExtensions.GetStringAsync Method

Reference

Definition

Namespace:: Microsoft.Extensions.Caching.Distributed

Assembly:: Microsoft.Extensions.Caching.Abstractions.dll

Package:: Microsoft.Extensions.Caching.Abstractions v6.0.0

Package:: Microsoft.Extensions.Caching.Abstractions v7.0.0

Package:: Microsoft.Extensions.Caching.Abstractions v8.0.0

Package:: Microsoft.Extensions.Caching.Abstractions v9.0.0-preview.2.24128.5

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

GetStringAsync(IDistributedCache, String)	Asynchronously gets a string from the specified cache with the specified key.
GetStringAsync(IDistributedCache, String, CancellationToken)	Asynchronously gets a string from the specified cache with the specified key.

GetStringAsync(IDistributedCache, String)

Asynchronously gets a string from the specified cache with the specified key.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(Microsoft::Extensions::Caching::Distributed::IDistributedCache ^ cache, System::String ^ key);

public static System.Threading.Tasks.Task<string> GetStringAsync (this Microsoft.Extensions.Caching.Distributed.IDistributedCache cache, string key);

static member GetStringAsync : Microsoft.Extensions.Caching.Distributed.IDistributedCache * string -> System.Threading.Tasks.Task<string>

<Extension()>
Public Function GetStringAsync (cache As IDistributedCache, key As String) 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.

Returns

Task<String>

A task that gets the string value from the stored cache key.

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

Applies to

GetStringAsync(IDistributedCache, String, CancellationToken)

Source:: DistributedCacheExtensions.cs

Source:: DistributedCacheExtensions.cs

Source:: DistributedCacheExtensions.cs

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

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)