DbCommand.PrepareAsync(CancellationToken) Metodo

Definizione

Spazio dei nomi:

System.Data.Common

Assembly:

System.Data.Common.dll

Source:

DbCommand.cs

Crea una versione preparata (o compilata) del comando nell'origine dati in modo asincrono.

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

Parametri

cancellationToken

CancellationToken

Token facoltativo per annullare l'operazione asincrona. Il valore predefinito è None.

Restituisce

Task

Task che rappresenta l'operazione asincrona.

Eccezioni

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

L'implementazione predefinita di questo metodo asincrono delega alla controparte sincrona e restituisce un oggetto completato Task, potenzialmente bloccando il thread chiamante.

I provider di dati che supportano la programmazione asincrona devono eseguire l'override dell'implementazione predefinita usando operazioni di I/O asincrone.

Se la CommandType proprietà è impostata su TableDirect, PrepareAsync non esegue alcuna operazione. Se CommandType è impostato su StoredProcedure, la chiamata a PrepareAsync deve avere esito positivo, anche se può comportare un'assenza di operazioni.

Questo metodo archivia nell'attività restituisce tutte le eccezioni non di utilizzo che la controparte sincrona del metodo può generare. Se un'eccezione viene archiviata nell'attività restituita, tale eccezione verrà generata quando l'attività è attesa. Le eccezioni di utilizzo, ad esempio ArgumentException, vengono comunque generate in modo sincrono. Per le eccezioni archiviate, vedere le eccezioni generate da Prepare().