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).