DbConnection.OpenAsync メソッド

  • リファレンス

定義

名前空間:
System.Data.Common
アセンブリ:
System.Data.Common.dll
アセンブリ:
System.Data.dll
アセンブリ:
netstandard.dll

このメソッドは、Open() の非同期バージョンを実装します。

オーバーロード

OpenAsync()

Open() で指定した設定を使用してデータベース接続を開く ConnectionString の非同期バージョン。 このメソッドは、CancellationToken.None で仮想メソッド OpenAsync(CancellationToken) を呼び出します。
OpenAsync(CancellationToken)

これは Open() の非同期バージョンです。 プロバイダーは、適切な実装でオーバーライドする必要があります。 オプションで、キャンセル トークン優先できます。

既定の実装は同期 Open() コールを呼び出し、完了したタスクを返します。 既定の実装は、既に取り消された cancellationToken を渡した場合、取り消されたタスクを返します。 Open によってスローされる例外は、返されたタスクの Exception プロパティを介して通信されます。

返されたタスクが完了するまで DbConnection オブジェクトの他のメソッドとプロパティを呼び出さないでください。

注釈

SQL Serverの.NET Framework データ プロバイダーでの非同期プログラミングの詳細については、「非同期プログラミング」を参照してください。

OpenAsync()

ソース:
DbConnection.cs
ソース:
DbConnection.cs
ソース:
DbConnection.cs

Open() で指定した設定を使用してデータベース接続を開く ConnectionString の非同期バージョン。 このメソッドは、CancellationToken.None で仮想メソッド OpenAsync(CancellationToken) を呼び出します。

public:
 System::Threading::Tasks::Task ^ OpenAsync();
public System.Threading.Tasks.Task OpenAsync ();
member this.OpenAsync : unit -> System.Threading.Tasks.Task
Public Function OpenAsync () As Task

戻り値

Task

非同期操作を表すタスク。

注釈

を呼び出したOpenAsyncState後、返Connectingされる Task が完了するまで を返す必要があります。 その後、接続が成功した場合は、 State を返す Open必要があります。 接続に失敗した場合は、 State を返す Closed必要があります。

の Close 呼び出しでは、対応する OpenAsync 呼び出しを取り消すか閉じようとします。

SQL Serverの.NET Framework データ プロバイダーでの非同期プログラミングの詳細については、「非同期プログラミング」を参照してください。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Open()スローされる例外に関するページを参照してください。

こちらもご覧ください

適用対象

OpenAsync(CancellationToken)

ソース:
DbConnection.cs
ソース:
DbConnection.cs
ソース:
DbConnection.cs

これは Open() の非同期バージョンです。 プロバイダーは、適切な実装でオーバーライドする必要があります。 オプションで、キャンセル トークン優先できます。

既定の実装は同期 Open() コールを呼び出し、完了したタスクを返します。 既定の実装は、既に取り消された cancellationToken を渡した場合、取り消されたタスクを返します。 Open によってスローされる例外は、返されたタスクの Exception プロパティを介して通信されます。

返されたタスクが完了するまで DbConnection オブジェクトの他のメソッドとプロパティを呼び出さないでください。

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

パラメーター

cancellationToken
CancellationToken

取り消し命令。

戻り値

Task

非同期操作を表すタスク。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

を呼び出したOpenAsyncState後、返Connectingされる Task が完了するまで を返す必要があります。 その後、接続が成功した場合は、 State を返す Open必要があります。 接続に失敗した場合は、 State を返す Closed必要があります。

の Close 呼び出しでは、対応する OpenAsync 呼び出しを取り消すか閉じようとします。

SQL Serverの.NET Framework データ プロバイダーでの非同期プログラミングの詳細については、「非同期プログラミング」を参照してください。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Open()スローされる例外に関するページを参照してください。

こちらもご覧ください

適用対象