SqlDataReader.ReadAsync(CancellationToken) Método

Definição

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Pacote:

System.Data.SqlClient v4.8.6

Uma versão assíncrona de Read(), que avança o SqlDataReader para o próximo registro.

O token de cancelamento pode ser usado para solicitar que a operação seja abandonada antes de expirar o tempo limite do comando. As exceções serão relatadas por meio do objeto de tarefa.

public:
 override System::Threading::Tasks::Task<bool> ^ ReadAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<bool> ReadAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Overrides Function ReadAsync (cancellationToken As CancellationToken) As Task(Of Boolean)

Parâmetros

cancellationToken

CancellationToken

A instrução de cancelamento.

Retornos

Task<Boolean>

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

Exceções

InvalidOperationException

Chamando ReadAsync(CancellationToken) mais de uma vez para a mesma instância antes da conclusão da tarefa.

Context Connection=true é especificado na cadeia de conexão.

SqlException

O SQL Server retornou um erro ao executar o texto do comando.

OperationCanceledException

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

Comentários

Se o behavior parâmetro de ExecuteReaderAsync for definido como Default, ReadAsync lerá a linha inteira antes de retornar a Tarefa.

Para obter mais informações, incluindo exemplos de código, sobre programação assíncrona no provedor de dados .NET Framework para SQL Server, 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 Read().

Confira também

• Visão geral do ADO.NET