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)，该方法的所有预期异常也在此处适用。