SqlConnection.OpenAsync(CancellationToken) SqlConnection.OpenAsync(CancellationToken) SqlConnection.OpenAsync(CancellationToken) Method

Определение

Асинхронная версия Open(), которая открывает соединение с базой данных с параметрами свойства, указанными в строке ConnectionString.An asynchronous version of Open(), which opens a database connection with the property settings specified by the ConnectionString. Чтобы запросить отмену операции до истечения времени ожидания соединения, можно использовать токен отмены.The cancellation token can be used to request that the operation be abandoned before the connection timeout elapses. Исключения будут распространяться с помощью возвращаемой задачи.Exceptions will be propagated via the returned Task. Если время ожидания соединения истекло без успешного подключения, возвращаемая задача будет помечена как сбойная с исключением.If the connection timeout time elapses without successfully connecting, the returned Task will be marked as faulted with an Exception. Реализация возвращает задачу без блокировки вызывающего потока как для соединений, помещенных в пул, так и соединений вне пула.The implementation returns a Task without blocking the calling thread for both pooled and non-pooled connections.

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

Параметры

cancellationToken
CancellationToken CancellationToken CancellationToken

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

Возвраты

Задача, представляющая асинхронную операцию.A task representing the asynchronous operation.

Исключения

Вызов OpenAsync(CancellationToken) более одного раза для того же экземпляра до завершения задачи.Calling OpenAsync(CancellationToken) more than once for the same instance before task completion.

Context Connection=true задается в строке подключения.Context Connection=true is specified in the connection string.

Подключение не было доступно из пула подключений до истечения времени ожидания подключения.A connection was not available from the connection pool before the connection time out elapsed.

Ошибка, возвращенная SQL Server, которая произошла при открытии соединения.Any error returned by SQL Server that occurred while opening the connection.

Комментарии

После вызова OpenAsyncметод State должен возвращать Connecting значение, Task пока не завершится возврат.After calling OpenAsync, State must return Connecting until the returned Task is completed. Затем, если соединение прошло успешно, State должно возвращаться. OpenThen, if the connection was successful, State must return Open. Если соединение не выполняется, State должно возвращаться Closedзначение.If the connection fails, State must return Closed.

Вызов метода Close предпримет попытку отменить или закрыть соответствующий OpenAsync вызов.A call to Close will attempt to cancel or close the corresponding OpenAsync call.

Дополнительные сведения об асинхронном программировании в поставщике .NET Framework данных для SQL Server см. в разделе Асинхронное программирование.For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.

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

Дополнительно