DbConnection.ChangeDatabaseAsync(String, CancellationToken) Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Modifica in modo asincrono il database corrente per una connessione aperta.
public virtual System.Threading.Tasks.Task ChangeDatabaseAsync(string databaseName, System.Threading.CancellationToken cancellationToken = default);
abstract member ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function ChangeDatabaseAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task
Parametri
- databaseName
- String
Nome del database da utilizzare per la connessione.
- cancellationToken
- CancellationToken
Token facoltativo per annullare l'operazione asincrona. Il valore predefinito è None.
Valori restituiti
Attività che rappresenta l'operazione asincrona.
Eccezioni
Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.
Commenti
Il valore specificato nel databaseName parametro deve essere un nome di database valido per l'istanza corrente.
L'implementazione predefinita di questo metodo asincrono delega alla controparte sincrona e restituisce un 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.
Questo metodo archivia nell'attività che 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 ChangeDatabase(String).