SqlConnection.OpenAsync(CancellationToken) 方法

定義

命名空間:

Microsoft.Data.SqlClient

組件:

Microsoft.Data.SqlClient.dll

套件:

Microsoft.Data.SqlClient v5.2.0

非同步版本的 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) 不止一次。

在連接逾時前，無法從連接集區取得連接。

SqlException

開啟連線時所發生並由 SQL Server 傳回的任何錯誤。

備註

呼叫 OpenAsync 之後， State 必須傳回 Connecting ，直到傳 Task 回的 完成為止。 然後，如果連線成功， State 則必須傳回 Open 。 如果連線失敗， State 必須傳回 Closed 。

的 Close 呼叫會嘗試取消或關閉對應的 OpenAsync 呼叫。

如需 .NET Framework Data Provider for SQL Server 中非同步程式設計的詳細資訊，請參閱非同步程式設計。