SqlCommand.ExecuteScalarAsync(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 , que executa a consulta de ExecuteScalar() forma assíncrona e retorna a primeira coluna da primeira linha no conjunto de resultados retornado pela consulta. Colunas ou linhas adicionais são ignoradas.

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<System::Object ^> ^ ExecuteScalarAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<object> ExecuteScalarAsync (System.Threading.CancellationToken cancellationToken);

override this.ExecuteScalarAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<obj>

Public Overrides Function ExecuteScalarAsync (cancellationToken As CancellationToken) As Task(Of Object)

Parâmetros

cancellationToken

CancellationToken

A instrução de cancelamento.

Retornos

Task<Object>

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

Exceções

ArgumentException

Um valor CommandBehavior inválido.

InvalidCastException

Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido como Stream . Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- ou -

Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando Value foi definido como TextReader .

-ou-

Um SqlDbType diferente de Xml foi usado quando Value foi definido como XmlReader .

InvalidOperationException

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

- ou -

O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

SqlException

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

- ou -

Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

IOException

Ocorreu um erro em um Stream objeto ou TextReaderXmlReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

ObjectDisposedException

O Stream objeto ou TextReaderXmlReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

Comentários

Para obter mais informações sobre programação assíncrona no provedor de dados .NET Framework para SQL Server, consulte Programação assíncrona.

Observação

Para consultas de execução prolongada no servidor, considere usar ExecuteScalar devido a um problema conhecido com o cancelamento de consultas por meio de um token de cancelamento. Além disso, considere cancelar a execução usando o Cancel método .