DbConnection.OpenAsync メソッド

定義

このメソッドは、Open() の非同期バージョンを実装します。This method implements an asynchronous version of Open().

オーバーロード

OpenAsync()

Open() で指定した設定を使用してデータベース接続を開く ConnectionString の非同期バージョン。An asynchronous version of Open(), which opens a database connection with the settings specified by the ConnectionString. このメソッドは、CancellationToken.None で仮想メソッド OpenAsync(CancellationToken) を呼び出します。This method invokes the virtual method OpenAsync(CancellationToken) with CancellationToken.None.

OpenAsync(CancellationToken)

これは Open() の非同期バージョンです。This is the asynchronous version of Open(). プロバイダーは、適切な実装でオーバーライドする必要があります。Providers should override with an appropriate implementation. オプションで、キャンセル トークン優先できます。The cancellation token can optionally be honored.

既定の実装は同期 Open() コールを呼び出し、完了したタスクを返します。The default implementation invokes the synchronous Open() call and returns a completed task. 既定の実装は、既に取り消された cancellationToken を渡した場合、取り消されたタスクを返します。The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Open によってスローされる例外は、返されたタスクの Exception プロパティを介して通信されます。Exceptions thrown by Open will be communicated via the returned Task Exception property.

返されたタスクが完了するまで DbConnection オブジェクトの他のメソッドとプロパティを呼び出さないでください。Do not invoke other methods and properties of the DbConnection object until the returned Task is complete.

注釈

SQL Server の .NET Framework Data Provider での非同期プログラミングの詳細については、「 非同期プログラミング」を参照してください。For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.

OpenAsync()

Open() で指定した設定を使用してデータベース接続を開く ConnectionString の非同期バージョン。An asynchronous version of Open(), which opens a database connection with the settings specified by the ConnectionString. このメソッドは、CancellationToken.None で仮想メソッド OpenAsync(CancellationToken) を呼び出します。This method invokes the virtual method OpenAsync(CancellationToken) with CancellationToken.None.

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

非同期操作を表すタスク。A task representing the asynchronous operation.

注釈

を呼び出した後、返されたが OpenAsync 完了するまで、はを State 返す必要があり Connecting Task ます。After calling OpenAsync, State must return Connecting until the returned Task is completed. 次に、接続が成功した場合、はを State 返す必要があり Open ます。Then, 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.

SQL Server の .NET Framework Data Provider での非同期プログラミングの詳細については、「 非同期プログラミング」を参照してください。For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.

適用対象

OpenAsync(CancellationToken)

これは Open() の非同期バージョンです。This is the asynchronous version of Open(). プロバイダーは、適切な実装でオーバーライドする必要があります。Providers should override with an appropriate implementation. オプションで、キャンセル トークン優先できます。The cancellation token can optionally be honored.

既定の実装は同期 Open() コールを呼び出し、完了したタスクを返します。The default implementation invokes the synchronous Open() call and returns a completed task. 既定の実装は、既に取り消された cancellationToken を渡した場合、取り消されたタスクを返します。The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Open によってスローされる例外は、返されたタスクの Exception プロパティを介して通信されます。Exceptions thrown by Open will be communicated via the returned Task Exception property.

返されたタスクが完了するまで DbConnection オブジェクトの他のメソッドとプロパティを呼び出さないでください。Do not invoke other methods and properties of the DbConnection object until the returned Task is complete.

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

取り消し命令。The cancellation instruction.

戻り値

Task

非同期操作を表すタスク。A task representing the asynchronous operation.

注釈

を呼び出した後、返されたが OpenAsync 完了するまで、はを State 返す必要があり Connecting Task ます。After calling OpenAsync, State must return Connecting until the returned Task is completed. 次に、接続が成功した場合、はを State 返す必要があり Open ます。Then, 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.

SQL Server の .NET Framework Data Provider での非同期プログラミングの詳細については、「 非同期プログラミング」を参照してください。For more information about asynchronous programming in the .NET Framework Data Provider for SQL Server, see Asynchronous Programming.

適用対象