SqlConnection.OpenAsync(CancellationToken) Метод

Определение

Пространство имен:
System.Data.SqlClient
Сборка:
System.Data.SqlClient.dll
Сборка:
System.Data.dll
Исходный код:
System.Data.SqlClient.notsupported.cs

Асинхронная версия Open(), которая открывает подключение к базе данных с параметрами свойств, указанными в параметре ConnectionString. Маркер отмены можно использовать для запроса на то, что операция будет прекращена до истечения времени ожидания подключения. Исключения будут распространяться через возвращаемую задачу. Если время ожидания подключения истекает без успешного подключения, возвращенная задача будет помечена как неисправная с исключением. Реализация возвращает задачу, не блокируя вызывающий поток для подключений, не относящихся к пулу.

public:
 override System::Threading::Tasks::Task ^ OpenAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task OpenAsync(System.Threading.CancellationToken cancellationToken);
override this.OpenAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function OpenAsync (cancellationToken As CancellationToken) As Task

Параметры

cancellationToken
CancellationToken

Инструкция отмены.

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

Task

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

Исключения

InvalidOperationException

Вызов OpenAsync(CancellationToken) нескольких раз для одного экземпляра перед завершением задачи.

Context Connection=true указывается в строка подключения.

Подключение было недоступно из пула подключений до истечения времени ожидания подключения.

SqlException

Любая ошибка, возвращенная SQL Server при открытии подключения.

OperationCanceledException

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

Комментарии

После вызова OpenAsyncState необходимо вернуться Connecting до завершения возвратаTask. Затем, если подключение выполнено успешно, State должно вернуться Open. Если подключение завершается ошибкой, State необходимо вернуть Closed.

Вызов, который Close попытается отменить или закрыть соответствующий OpenAsync вызов.

Дополнительные сведения об асинхронном программировании в Data Provider Data Provider SQL Server см. .NET в разделе Asynchronous Programming.

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

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

См. также раздел