DbConnection.ChangeDatabaseAsync(String, CancellationToken) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Troca de forma assíncrona o banco de dados atual por uma conexão aberta.
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
Parâmetros
- databaseName
- String
O nome do banco de dados a ser usado pela conexão.
- cancellationToken
- CancellationToken
Um token opcional para cancelar a operação assíncrona. O valor padrão é None.
Retornos
Uma tarefa que representa a operação assíncrona.
Exceções
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
Comentários
O valor fornecido no databaseName
parâmetro deve ser um nome de banco de dados válido para a instância atual.
A implementação padrão desse método assíncrono delega ao seu equivalente síncrono e retorna um concluído Task
, potencialmente bloqueando o thread de chamada.
Os provedores de dados que dão suporte à programação assíncrona devem substituir a implementação padrão usando operações de E/S assíncronas.
Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por ChangeDatabase(String).