SqlBatch.ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) Método

Definição

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Pacote:

Microsoft.Data.SqlClient v7.1.0

Essa implementação invoca o ExecuteReaderAsync() método e retorna uma tarefa concluída. A implementação padrão retornará uma tarefa cancelada se passar um token de cancelamento já cancelado. Esse método aceita um token de cancelamento que pode ser usado para solicitar que a operação seja cancelada antecipadamente.

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)

Parâmetros

behavior

CommandBehavior

Uma instância de CommandBehavior, especificando opções de execução em lote e recuperação de dados. Somente SequentialAccess e CloseConnection há suporte no nível do lote.

cancellationToken

CancellationToken

Um token para cancelar a operação assíncrona.

Retornos

Task<DbDataReader>

Uma tarefa que representa a operação assíncrona.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Para obter mais informações sobre programação assíncrona, consulte Programação Assíncrona.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por ExecuteDbDataReader(CommandBehavior).

Note

Esse método se beneficia ExecuteReaderAsync(CancellationToken)e todas as exceções esperadas desse método também se aplicam aqui.