SqlDataReader.ReadAsync(CancellationToken) メソッド

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

次のレコードに Read() を進める SqlDataReader の非同期バージョン。

キャンセル トークンを使用すると、コマンド タイムアウトが経過する前に操作を破棄するように要求できます。 例外は、返されたタスク オブジェクトによって報告されます。

public:
 override System::Threading::Tasks::Task<bool> ^ ReadAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<bool> ReadAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Overrides Function ReadAsync (cancellationToken As CancellationToken) As Task(Of Boolean)

パラメーター

cancellationToken

CancellationToken

取り消し命令。

戻り値

Task<Boolean>

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

例外

InvalidOperationException

タスクの完了前に、同じインスタンスに対して ReadAsync(CancellationToken) を複数回呼び出しています。

SqlException

SQL Server がコマンド テキストの実行中にエラーを返しました。

注釈

の パラメーターExecuteReaderAsyncが behavior に設定されている場合は、Task をDefaultReadAsync返す前に行全体を読み取ります。

.NET Framework Data Provider for SQL Serverでの非同期プログラミングに関するコード サンプルを含む詳細については、「非同期プログラミング」を参照してください。

注意

大きなデータ (バイナリ/テキスト) を読み取る場合は、最適なパフォーマンスを得るために を使用 Read することをお勧めします。