SqlConnection.OpenAsync(CancellationToken) 方法

定义

异步版本的 ,它使用 <a1/> 指定的属性设置打开数据库连接。 取消令牌可用于请求在连接超时过前放弃操作。 异常将通过返回的任务传播。 如果连接超时时间未成功连接,则返回的任务将标记为出错并出现异常。 实现返回一个任务,而不会阻止池连接和非共用连接的调用线程。

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

取消指令。

返回

表示异步操作的任务。

例外

在任务完成前多次为同一实例调用 OpenAsync(CancellationToken) 一次。

Context Connection=true在连接字符串中指定。

在连接超时之前,连接池中不可用。

打开连接时发生SQL Server返回的任何错误。

取消令牌已取消。 此异常存储在返回的任务中。

注解

调用 OpenAsync后, State 必须返回 Connecting ,直到返回 Task 的完成。 然后,如果连接成功, State 则必须返回 Open。 如果连接失败, State 则必须返回 Closed

调用 Close 将尝试取消或关闭相应的 OpenAsync 调用。

有关 .NET Framework Data Provider 中用于SQL Server的异步编程的详细信息,请参阅 Asynchronous Programming

此方法存储在任务中,它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中,则等待任务时将引发该异常。 使用情况异常(例如 ArgumentException)仍会同步引发。 有关存储的异常,请参阅由 Open()..

适用于

另请参阅