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

定義

名前空間:: Microsoft.Data.SqlClient

アセンブリ:: Microsoft.Data.SqlClient.dll

パッケージ:: Microsoft.Data.SqlClient v7.1.0

パッケージ:: Microsoft.Data.SqlClient v5.2.0

パッケージ:: Microsoft.Data.SqlClient v6.0.2

パッケージ:: Microsoft.Data.SqlClient v6.1.3

パッケージ:: Microsoft.Data.SqlClient v7.0.3

ソース:: SqlBatch.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

この実装は、 ExecuteReaderAsync() メソッドを呼び出し、完了したタスクを返します。既定の実装では、既に取り消されたキャンセルトークンが渡された場合、取り消されたタスクが返されます。このメソッドは、早期に取り消す操作を要求するために使用できるキャンセルトークンを受け入れます。

protected:
 virtual 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);

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

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

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

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

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

パラメーター

behavior: CommandBehavior

バッチ実行とデータ取得のオプションを指定する CommandBehaviorのインスタンス。バッチレベルでは、 SequentialAccess と CloseConnection のみがサポートされます。

cancellationToken: CancellationToken

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

返品

Task<DbDataReader>

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

例外

OperationCanceledException

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

注釈

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

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

Note

このメソッドは ExecuteReaderAsync(CancellationToken)の利点があり、そのメソッドのすべての予期される例外もここに適用されます。

適用対象