SqlDataReader.ReadAsync(CancellationToken) Método

Definição

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Pacote:

Microsoft.Data.SqlClient v5.2.0

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.

SqlException

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

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.

Observação

Ao ler dados grandes (binário/texto), é recomendável usar para o Read desempenho ideal.