SqlBatch.ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) Método

Definição

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Pacote:

Microsoft.Data.SqlClient v5.2.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 já tiver passado um token de cancelamento.

Esse método aceita um token de cancelamento que pode ser usado para solicitar a operação a ser cancelada no início.

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)

Parâmetros

behavior

CommandBehavior

Um dos valores de enumeração que especifica opções para execução em lote 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

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 a contraparte síncrona 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).

Observação

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