DbConnection.ChangeDatabaseAsync(String, CancellationToken) メソッド

定義

名前空間:

System.Data.Common

アセンブリ:

System.Data.Common.dll

ソース:

DbConnection.cs

開いている接続の現在のデータベースを非同期に変更します。

public virtual System.Threading.Tasks.Task ChangeDatabaseAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);

abstract member ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function ChangeDatabaseAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

databaseName

String

使用する接続のデータベースの名前。

cancellationToken

CancellationToken

非同期操作を取り消すオプションのトークン。 既定値は None です。

戻り値

Task

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

例外

OperationCanceledException

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

注釈

パラメーターに databaseName 指定する値は、現在のインスタンスの有効なデータベース名である必要があります。

この非同期メソッドの既定の実装は、その同期メソッドにデリゲートし、完了した Taskを返します。呼び出し元のスレッドをブロックしている可能性があります。

非同期プログラミングをサポートするデータ プロバイダーは、非同期 I/O 操作を使用して既定の実装をオーバーライドする必要があります。

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