LogProviderBase.CanUpdate(String) メソッド

定義

ログ プロバイダーで、パッケージ XML を新しいバージョンのログ プロバイダーにアップグレードする機能がサポートされているかどうかを示します。

public:
 virtual bool CanUpdate(System::String ^ CreationName);
public virtual bool CanUpdate (string CreationName);
abstract member CanUpdate : string -> bool
override this.CanUpdate : string -> bool
Public Overridable Function CanUpdate (CreationName As String) As Boolean

パラメーター

CreationName
String

オブジェクトのインスタンスを作成するために使用される文字列です。

戻り値

Boolean

パラメーターで CreationName 指定されたログ プロバイダーがそのオブジェクト メタデータを更新できる場合は true、それ以外の場合は false。 既定値は false です。

注釈

ログ プロバイダーのパッケージ XML を更新する機能を持つ新しいバージョンのログ プロバイダーを配布するときに、ログ プロバイダー内のこのメソッドをオーバーライドします。 ランタイム エンジンを返 true す場合は、メソッドを Update 呼び出して、ログ プロバイダーのパッケージ XML を更新します。

たとえば、バージョン A のログ プロバイダーを配置し、SaveToXml メソッドをオーバーライドすることによって、パッケージ XML にいくつかのカスタム プロパティを格納したとします。 後日に、このプロパティはサポートせず、新しいプロパティを持つバージョン B のログ プロバイダーを配布します。 この場合、パッケージに含まれているログ プロバイダーの Version プロパティが A であり、コンピューターにインストールされているログ プロバイダーが B であることをランタイム エンジンが検出すると、ランタイム エンジンはこのメソッドを呼び出して、使用しているログ プロバイダーがパッケージ XML を更新できるかどうかを確認します。 true が返される場合、ランタイム エンジンは Update メソッドを呼び出します。これでパッケージ XML を更新できます。

適用対象