SqlConnection.OpenAsync(CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Open()の非同期バージョン。ConnectionStringで指定されたプロパティ設定を使用してデータベース接続を開きます。 キャンセル トークンを使用して、接続タイムアウトが経過する前に操作を破棄するように要求できます。 例外は、返されたタスクを介して伝達されます。 正常に接続せずに接続タイムアウト時間が経過すると、返されたタスクは例外でエラーとしてマークされます。 この実装は、プールされた接続とプールされていない接続の両方の呼び出し元スレッドをブロックせずに Task を返します。
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.TaskPublic Overrides Function OpenAsync (cancellationToken As CancellationToken) As Taskパラメーター
- cancellationToken
- CancellationToken
取り消し命令。
返品
非同期操作を表すタスク。
例外
タスクが完了する前に、同じインスタンスに対して OpenAsync(CancellationToken) を複数回呼び出します。
Context Connection=trueは、接続文字列で指定します。
接続タイムアウトが経過する前に、接続プールから接続を使用できませんでした。
接続を開くときに発生したSQL Serverによって返されたエラー。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
OpenAsyncを呼び出した後、Stateは、返されたTaskが完了するまでConnectingを返す必要があります。 接続が成功した場合、 State は Openを返す必要があります。 接続に失敗した場合、 State は Closedを返す必要があります。
Closeの呼び出しは、対応するOpenAsync呼び出しをキャンセルまたは閉じようとします。
SQL Serverの.NET Framework Data Providerでの非同期プログラミングの詳細については、「Asynchronous Programming」を参照してください。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Open()によってスローされる例外を参照してください。