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

定義

名前空間:

System.Data.Common

アセンブリ:

System.Data.Common.dll

ソース:

DbCommand.cs

プロバイダーは、ExecuteReader のオーバーロードに既定以外の実装を提供するには、このメソッドを実装する必要があります。

既定の実装は ExecuteReader() 同期メソッドを呼び出し、完了したタスクを返します。呼び出し元のスレッドはブロックされます。 既定の実装は、既に取り消されたキャンセル トークンを渡した場合、取り消されたタスクを返します。 ExecuteReader によってスローされる例外は、返されたタスクの Exception プロパティを介して通信されます。

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

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

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>

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

パラメーター

behavior

CommandBehavior

のインスタンス。コマンドの CommandBehavior実行とデータ取得のオプションを指定します。

cancellationToken

CancellationToken

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

戻り値

Task<DbDataReader>

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

例外

DbException

コマンドの実行中にエラーが発生しました。

ArgumentException

正しくない CommandBehavior 値。

OperationCanceledException

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

注釈

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

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

こちらもご覧ください

• ADO.NET の概要