DbConnection.ChangeDatabaseAsync(String, CancellationToken) Méthode

Définition

Espace de noms:

System.Data.Common

Assembly:

System.Data.Common.dll

Source:

DbConnection.cs

Change de manière asynchrone la base de données actuelle pour une connexion ouverte.

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

Paramètres

databaseName

String

Le nom de la base de données de la connexion à utiliser.

cancellationToken

CancellationToken

Jeton facultatif pour annuler l’opération asynchrone. La valeur par défaut est None.

Retours

Task

Tâche représentant l’opération asynchrone.

Exceptions

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

La valeur fournie dans le databaseName paramètre doit être un nom de base de données valide pour le instance actuel.

L’implémentation par défaut de cette méthode asynchrone délègue à son équivalent synchrone et retourne un , Taskce qui bloque potentiellement le thread appelant.

Les fournisseurs de données qui prennent en charge la programmation asynchrone doivent remplacer l’implémentation par défaut à l’aide d’opérations d’E/S asynchrones.

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que le équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour les exceptions stockées, consultez les exceptions levées par ChangeDatabase(String).