SqlBatch.ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) 方法

定义

命名空间:

Microsoft.Data.SqlClient

程序集:

Microsoft.Data.SqlClient.dll

程序包:

Microsoft.Data.SqlClient v7.1.0

此实现调用 ExecuteReaderAsync() 该方法并返回已完成的任务。 如果传递已取消的取消令牌，则默认实现将返回已取消的任务。 此方法接受一个取消令牌，该令牌可用于请求提前取消操作。

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，指定用于批处理执行和数据检索的选项。 CloseConnection仅在SequentialAccess批处理级别受支持。

cancellationToken

CancellationToken

用于取消异步操作的令牌。

返回

Task<DbDataReader>

表示异步操作的任务。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

有关异步编程的详细信息，请参阅 异步编程。

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用情况异常（例如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅由 ExecuteDbDataReader(CommandBehavior)..

注释

此方法受益于 ExecuteReaderAsync(CancellationToken)此方法，并且该方法的所有预期异常也在此处适用。