DbConnection.ChangeDatabaseAsync(String, CancellationToken) Metod

Definition

Asynkront ändrar den aktuella databasen för en öppen anslutning.

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

Parametrar

databaseName
String

Namnet på databasen som anslutningen ska använda.

cancellationToken
CancellationToken

En valfri token för att avbryta den asynkrona åtgärden. Standardvärdet är None.

Returer

En uppgift som representerar den asynkrona åtgärden.

Undantag

Annulleringstoken avbröts. Det här undantaget lagras i den returnerade aktiviteten.

Kommentarer

Värdet som anges i parametern databaseName måste vara ett giltigt databasnamn för den aktuella instansen.

Standardimplementeringen av den här asynkrona metoden delegerar till sin synkrona motsvarighet och returnerar en slutförd Task, som potentiellt blockerar den anropande tråden.

Dataprovidrar som stöder asynkron programmering bör åsidosätta standardimplementeringen med hjälp av asynkrona I/O-åtgärder.

Den här metoden lagrar i aktiviteten som returnerar alla undantag som inte används som metodens synkrona motsvarighet kan utlösa. Om ett undantag lagras i den returnerade aktiviteten utlöses undantaget när aktiviteten väntar. Användningsfel, till exempel ArgumentException, genereras fortfarande synkront. De lagrade undantagen finns i undantagen som genereras av ChangeDatabase(String).

Gäller för