SqlConnection.OpenAsync(CancellationToken) Metoda

Definicja

Przestrzeń nazw:

Microsoft.Data.SqlClient

Zestaw:

Microsoft.Data.SqlClient.dll

Pakiet:

Microsoft.Data.SqlClient v5.2.0

Wersja asynchroniczna programu Open(), która otwiera połączenie bazy danych z ustawieniami właściwości określonymi przez element ConnectionString. Token anulowania może służyć do żądania, aby operacja została porzucona przed upływem limitu czasu połączenia. Wyjątki będą propagowane za pośrednictwem zwróconego zadania. Jeśli limit czasu połączenia upłynie bez pomyślnego nawiązania połączenia, zwrócone zadanie zostanie oznaczone jako błędne z powodu wyjątku. Implementacja zwraca zadanie bez blokowania wątku wywołującego dla połączeń w puli i bez puli.

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

Parametry

cancellationToken

CancellationToken

Instrukcja anulowania.

Zwraca

Task

Zadanie reprezentujące operację asynchroniczną.

Wyjątki

InvalidOperationException

Wywołanie OpenAsync(CancellationToken) więcej niż raz dla tego samego wystąpienia przed ukończeniem zadania.

Połączenie nie było dostępne z puli połączeń przed upływem limitu czasu połączenia.

SqlException

Wszelkie błędy zwrócone przez SQL Server, które wystąpiły podczas otwierania połączenia.

Uwagi

Po wywołaniu metody OpenAsyncState należy powrócić Connecting do momentu ukończenia zwróconej Task wartości. Następnie, jeśli połączenie zakończyło się pomyślnie, State musi zwrócić wartość Open. Jeśli połączenie nie powiedzie się, State należy zwrócić wartość Closed.

Wywołanie metody , aby Close podjąć próbę anulowania lub zamknięcia odpowiedniego OpenAsync wywołania.

Aby uzyskać więcej informacji na temat programowania asynchronicznego w programie .NET Framework Data Provider for SQL Server, zobacz Asynchronous Programming (Programowanie asynchroniczne).