DbCommand.ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) Método

Definição

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Os provedores devem implementar esse método para fornecer uma implementação não padrão para sobrecargas ExecuteReader.

A implementação padrão invoca o método ExecuteReader() síncrono e retorna uma tarefa concluída, bloqueando o thread de chamada. A implementação padrão retornará uma tarefa cancelada se já tiver passado um token de cancelamento. Exceções geradas por ExecuteReader serão comunicadas por meio da propriedade Exceção de Tarefa retornada.

Esse método aceita um token de cancelamento que pode ser usado para solicitar a operação a ser cancelada no início. As implementações podem ignorar essa solicitação.

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 para execução de comando e recuperação de dados.

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

DbException

Ocorreu um erro durante a execução do comando.

ArgumentException

Um valor CommandBehavior inválido.

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).

Confira também

• Visão geral do ADO.NET