DbCommand.PrepareAsync(CancellationToken) メソッド

定義

名前空間:

System.Data.Common

アセンブリ:

System.Data.Common.dll

ソース:

DbCommand.cs

準備済み (またはコンパイル済み) バージョンのコマンドをデータ ソース上に非同期に作成します。

public virtual System.Threading.Tasks.Task PrepareAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function PrepareAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

cancellationToken

CancellationToken

非同期操作を取り消すオプションのトークン。 既定値は None です。

戻り値

Task

非同期操作を表す Task。

例外

OperationCanceledException

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

注釈

この非同期メソッドの既定の実装は、その同期メソッドにデリゲートし、完了した Taskを返します。呼び出し元のスレッドがブロックされる可能性があります。

非同期プログラミングをサポートするデータ プロバイダーは、非同期 I/O 操作を使用して既定の実装をオーバーライドする必要があります。

プロパティが CommandType にTableDirectPrepareAsync設定されている場合、何も行われません。 が にStoredProcedure設定されている場合CommandType、 のPrepareAsync呼び出しは成功するはずですが、操作が失敗する可能性があります。

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