DbConnection.ChangeDatabaseAsync(String, CancellationToken) Metoda

Definice

Obor názvů:

System.Data.Common

Sestavení:

System.Data.Common.dll

Zdroj:

DbConnection.cs

Asynchronně změní aktuální databázi pro otevřené připojení.

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

Parametry

databaseName

String

Název databáze pro připojení, které se má použít.

cancellationToken

CancellationToken

Volitelný token pro zrušení asynchronní operace. Výchozí hodnota je None.

Návraty

Task

Úloha představující asynchronní operaci

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

Poznámky

Hodnota zadaná v parametru databaseName musí být platným názvem databáze pro aktuální instanci.

Výchozí implementace této asynchronní metody deleguje na svůj synchronní protějšek a vrátí dokončený Task, potenciálně blokuje volající vlákno.

Zprostředkovatelé dat, kteří podporují asynchronní programování , by měli přepsat výchozí implementaci pomocí asynchronních vstupně-výstupních operací.

Tato metoda ukládá do úlohy, která vrací všechny výjimky nepouužování, které může vyvolat synchronní protějšek metody. Pokud je do vrácené úlohy uložena výjimka, bude tato výjimka vyvolána, když je úloha očekávána. Výjimky použití, jako ArgumentExceptionje , se stále vyvolává synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem ChangeDatabase(String).