SqlConnection.OpenAsync(CancellationToken) Méthode

  • Référence

Définition

Espace de noms:
System.Data.SqlClient
Assembly:
System.Data.SqlClient.dll
Assembly:
System.Data.dll
Paquet:
System.Data.SqlClient v4.8.6

Version asynchrone de Open(), qui ouvre une connexion de base de données avec les paramètres de propriété spécifiés par ConnectionString. Le jeton d'annulation peut être utilisé pour demander l'abandon de l'opération avant que le délai d'attente de connexion s'écoule. Les exceptions seront propagées via la tâche retournée. Si le délai d'attente de connexion s'écoule sans connexion réussie, la tâche retournée est marquée comme défaillante avec une exception. L'implémentation retourne une tâche sans bloquer le thread appelant pour les connexions regroupées et non regroupées.

public:
 override System::Threading::Tasks::Task ^ OpenAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task OpenAsync (System.Threading.CancellationToken cancellationToken);
override this.OpenAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function OpenAsync (cancellationToken As CancellationToken) As Task

Paramètres

cancellationToken
CancellationToken

Instruction d'annulation.

Retours

Task

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

Exceptions

InvalidOperationException

Appels multiples de OpenAsync(CancellationToken) pour la même instance avant la fin de la tâche.

Context Connection=true est spécifié dans la chaîne de connexion.

Aucune connexion n’était disponible à partir du pool de connexions avant la fin du délai d’expiration de la connexion.

SqlException

Toute erreur retournée par SQL Server qui s’est produite à l’ouverture de la connexion.

OperationCanceledException

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

Remarques

Après avoir appelé OpenAsync, State doit retourner Connecting jusqu’à ce que le retourné Task soit terminé. Ensuite, si la connexion a réussi, State doit retourner Open. Si la connexion échoue, State doit retourner Closed.

Un appel à Close tente d’annuler ou de fermer l’appel correspondant OpenAsync .

Pour plus d’informations sur la programmation asynchrone dans le fournisseur de données .NET Framework pour SQL Server, consultez Programmation asynchrone.

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

S’applique à

Voir aussi