DbCommand.PrepareAsync(CancellationToken) Método

Definição

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Cria de maneira assíncrona uma versão preparada (ou compilada) do comando na fonte de dados.

public virtual System.Threading.Tasks.Task PrepareAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.PrepareAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function PrepareAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

cancellationToken

CancellationToken

Um token opcional para cancelar a operação assíncrona. O valor padrão é None.

Retornos

Task

Um Task representando a operação assíncrona.

Exceções

OperationCanceledException

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

Comentários

A implementação padrão desse método assíncrono delega ao seu equivalente síncrono e retorna um concluído Task, potencialmente bloqueando o thread de chamada.

Os provedores de dados que dão suporte à programação assíncrona devem substituir a implementação padrão usando operações de E/S assíncronas.

Se a CommandType propriedade estiver definida TableDirectcomo , PrepareAsync não fará nada. Se CommandType for definido StoredProcedurecomo , a chamada para PrepareAsync deverá ter êxito, embora possa resultar em uma no-op.

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