Language

IAsyncValidateOptions<TOptions>.ValidateAsync メソッド

定義

指定した名前付きオプション インスタンスを非同期的に検証します (または、 name が nullされている場合はすべて)。

public System.Threading.Tasks.Task<Microsoft.Extensions.Options.ValidateOptionsResult> ValidateAsync(string? name, TOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member ValidateAsync : string * 'Options * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.Options.ValidateOptionsResult>
Public Function ValidateAsync (name As String, options As TOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ValidateOptionsResult)

パラメーター

name
String

検証対象のオプション インスタンスの名前。

options
TOptions

オプション インスタンス。

cancellationToken
CancellationToken

キャンセル要求を監視するトークン。

戻り値

ValidateOptionsResult結果。

注釈

このメソッドは、同期的に完了できるチェックを含め、この検証コントロールに適用されるすべてのチェックを実行する必要があります。 組み込みの非同期オプション作成パスは、同じ検証コントロールで Validate(String, TOptions) を呼び出す代わりに、このメソッドを呼び出します。 必要に応じて、ヘルパーを介して共通のチェックを共有します。 同期オプションの作成では、継承された Validate(String, TOptions) メソッドが呼び出されます。 可能な場合は、同等の同期検証を使用してそのメソッドを実装します。 必要な規則が適用されても同期的に評価できない場合は、同期検証がサポートされていないことを示す失敗した ValidateOptionsResult を返します。 Successを返さないでください。

適用対象