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

其中一個列舉值，指定批次執行和數據擷取的選項。

cancellationToken

CancellationToken

取消非同步作業的語彙基元。

傳回

Task<DbDataReader>

表示非同步作業的工作。

例外狀況

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

如需異步程式設計的詳細資訊，請參閱 異步程序設計。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ExecuteDbDataReader(CommandBehavior)例外狀況。

注意

這個方法受益於 ExecuteReaderAsync(CancellationToken)，而且該方法的所有預期例外狀況也適用於這裡。