SqlConnection.OpenAsync(CancellationToken) Methode

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Paket:

Microsoft.Data.SqlClient v5.2.0

Eine asynchrone Version von Open(), die eine Datenbankverbindung mit den Eigenschaftseinstellungen öffnet, die durch ConnectionString angegeben sind. Das Abbruchtoken kann verwendet werden, um anzufordern, dass der Vorgang abgebrochen wird, bevor das Timeout der Verbindung abläuft. Ausnahmen werden über die zurückgegebene Aufgabe weitergegeben. Wenn die Timeout-Zeit für die Verbindung abläuft, ohne die Verbindung erfolgreich herzustellen, wird die zurückgegebene Aufgabe als fehlgeschlagen mit einer Ausnahme markiert. Die Implementierung gibt eine Aufgabe zurück, ohne den aufrufenden Verbindungs-Thread zu blockieren (gilt auch für Pool-Verbindungen).

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

Parameter

cancellationToken

CancellationToken

Die Abbruchanweisung.

Gibt zurück

Task

Eine Aufgabe, die den asynchronen Vorgang darstellt.

Ausnahmen

InvalidOperationException

OpenAsync(CancellationToken) wird vor dem Abschluss der Aufgabe mehrmals für dieselbe Instanz aufgerufen.

Es war keine Verbindung aus dem Verbindungspool verfügbar, bevor ein Timeout für die Verbindung aufgetreten ist.

SqlException

Jeder von SQL Server zurückgegebene Fehler, der beim Öffnen der Verbindung aufgetreten ist.

Hinweise

Nach dem Aufruf StateOpenAsyncmuss zurückgegeben werden, Connecting bis die zurückgegebene Task abgeschlossen ist. Wenn die Verbindung erfolgreich war, State muss zurückgegeben werden Open. Wenn die Verbindung fehlschlägt, State muss zurückgegeben Closedwerden.

Ein Aufruf von Close versucht, den entsprechenden OpenAsync Anruf abzubrechen oder zu schließen.

Weitere Informationen zur asynchronen Programmierung im .NET Framework Datenanbieter für SQL Server finden Sie unter Asynchrone Programmierung.