DbConnection.ChangeDatabaseAsync(String, CancellationToken) Метод

Определение

Асинхронно изменяет текущую базу данных для открытого подключения.

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

Параметры

databaseName
String

Имя базы данных для используемого подключения.

cancellationToken
CancellationToken

Необязательный маркер для отмены асинхронной операции. Значение по умолчанию — None.

Возвращаемое значение

Задача, представляющая асинхронную операцию.

Исключения

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

Комментарии

Значение, указанное в параметре databaseName , должно быть допустимым именем базы данных для текущего экземпляра.

Реализация этого асинхронного метода по умолчанию делегирует его синхронный аналог и возвращает завершенный Task, потенциально блокируя вызывающий поток.

Поставщики данных, поддерживающие асинхронное программирование, должны переопределить реализацию по умолчанию с помощью асинхронных операций ввода-вывода.

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых ChangeDatabase(String).

Применяется к