DbConnection.ChangeDatabaseAsync(String, CancellationToken) Metodo

Definizione

Spazio dei nomi:

System.Data.Common

Assembly:

System.Data.Common.dll

Source:

DbConnection.cs

Cambia il database corrente in modo asincrono 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

Specifica il nome del database per la connessione da usare.

cancellationToken

CancellationToken

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

Restituisce

Task

Attività che rappresenta l'operazione asincrona.

Eccezioni

OperationCanceledException

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 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.

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 ChangeDatabase(String).