DbDataSource.OpenConnectionAsync(CancellationToken) メソッド

定義

名前空間:

System.Data.Common

アセンブリ:

System.Data.Common.dll

ソース:

DbDataSource.cs

この DbDataSourceで表されるデータベースへの新しい開いている接続を非同期的に返します。

public System.Threading.Tasks.ValueTask<System.Data.Common.DbConnection> OpenConnectionAsync (System.Threading.CancellationToken cancellationToken = default);

member this.OpenConnectionAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Data.Common.DbConnection>

Public Function OpenConnectionAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of DbConnection)

パラメーター

cancellationToken

CancellationToken

非同期操作を取り消すトークン。

戻り値

ValueTask<DbConnection>

この DbDataSourceで表されるデータベースへの新しいオープン接続。

例外

OperationCanceledException

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

注釈

返された接続は既に開いているため、すぐに使用できます。

呼び出し元は、このメソッドによって返された接続を適切に破棄する必要があります。 これを行わないと、接続リークが発生する可能性があります。

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