DbConnection.ChangeDatabaseAsync(String, CancellationToken) Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Altera assíncronamente a base de dados atual para uma ligaçã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 da base de dados para a ligação a utilizar.
- cancellationToken
- CancellationToken
Um token opcional para cancelar a operação assíncrona. O valor predefinido é None.
Devoluções
Uma tarefa que representa a operação assíncrona.
Exceções
O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.
Observações
O valor fornecido no databaseName parâmetro deve ser um nome válido de base de dados para a instância atual.
A implementação padrão deste método assíncrono delega ao seu equivalente síncrono e devolve um completo Task, potencialmente bloqueando o thread que chama.
Os fornecedores de dados que suportam programação assíncrona devem sobrepor a implementação padrão usando operações de I/O assíncronas.
Este método armazena na tarefa que devolve todas as exceções de não-utilização que o equivalente síncrono do método pode lançar. Se uma exceção for armazenada na tarefa devolvida, essa exceção será lançada quando a tarefa for aguardada. As exceções de uso, como ArgumentException, ainda são lançadas de forma síncrona. Para as exceções armazenadas, veja as exceções lançadas por ChangeDatabase(String).