SqlBatch.ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) メソッド

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

この実装では、 メソッドを ExecuteReaderAsync() 呼び出し、完了したタスクを返します。 既定の実装は、既に取り消されたキャンセル トークンを渡した場合、取り消されたタスクを返します。

このメソッドは、早期に操作をキャンセルすることを要求するために使用できるキャンセル トークンを受け取ります。

protected:
 override System::Threading::Tasks::Task<System::Data::Common::DbDataReader ^> ^ ExecuteDbDataReaderAsync(System::Data::CommandBehavior behavior, System::Threading::CancellationToken cancellationToken);

protected override System.Threading.Tasks.Task<System.Data.Common.DbDataReader> ExecuteDbDataReaderAsync (System.Data.CommandBehavior behavior, System.Threading.CancellationToken cancellationToken);

override this.ExecuteDbDataReaderAsync : System.Data.CommandBehavior * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.Common.DbDataReader>

Protected Overrides Function ExecuteDbDataReaderAsync (behavior As CommandBehavior, cancellationToken As CancellationToken) As Task(Of DbDataReader)

パラメーター

behavior

CommandBehavior

バッチ実行とデータ取得のオプションを指定する列挙値の 1 つ。

cancellationToken

CancellationToken

非同期操作を取り消すトークン。

戻り値

Task<DbDataReader>

非同期操作を表すタスク。

例外

OperationCanceledException

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

注釈

非同期プログラミングの詳細については、「 非同期プログラミング」を参照してください。

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

注意

このメソッドは から ExecuteReaderAsync(CancellationToken)メリットを得て、そのメソッドの予期されるすべての例外もここに適用されます。