DbConnection.ChangeDatabaseAsync(String, CancellationToken) Metoda

Definice

Obor názvů:

System.Data.Common

Sestavení:

netstandard.dll, 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, která se má použít pro připojení.

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 je uložena 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 její 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 všechny výjimky bez použití, které může vyvolat synchronní protějšek metody. Pokud je výjimka uložena do vrácené úlohy, tato výjimka bude vyvolána, když je úkol očekáván. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. V případě uložených výjimek se podívejte na výjimky vyvolané ChangeDatabase(String).