DistributedCacheExtensions.GetStringAsync メソッド

定義

名前空間:

Microsoft.Extensions.Caching.Distributed

アセンブリ:

Microsoft.Extensions.Caching.Abstractions.dll

パッケージ:

Microsoft.Extensions.Caching.Abstractions v9.0.0-preview.3.24172.9

ソース:

DistributedCacheExtensions.cs

指定したキーを使用して、指定したキャッシュから文字列を非同期で取得します。

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)

パラメーター

cache

IDistributedCache

データを格納するキャッシュ。

key

String

格納されているデータを取得するキー。

token

CancellationToken

任意。 操作を取り消すための CancellationToken。

戻り値

Task<String>

格納されているキャッシュ キーからの文字列値を取得するタスク。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

このメソッドは、メソッドの同期的な例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクの待機時にスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって GetString(IDistributedCache, String)スローされる例外に関するページを参照してください。