LocalFileSettingsProvider.Upgrade メソッド

定義

名前空間:

System.Configuration

アセンブリ:

System.Configuration.ConfigurationManager.dll

パッケージ:

System.Configuration.ConfigurationManager v8.0.0

ソース:

LocalFileSettingsProvider.cs

同じアプリケーションの以前のバージョンから、ユーザー スコープの以前の設定の移行を試みます。

public:
 virtual void Upgrade(System::Configuration::SettingsContext ^ context, System::Configuration::SettingsPropertyCollection ^ properties);

public void Upgrade (System.Configuration.SettingsContext context, System.Configuration.SettingsPropertyCollection properties);

abstract member Upgrade : System.Configuration.SettingsContext * System.Configuration.SettingsPropertyCollection -> unit
override this.Upgrade : System.Configuration.SettingsContext * System.Configuration.SettingsPropertyCollection -> unit

Public Sub Upgrade (context As SettingsContext, properties As SettingsPropertyCollection)

パラメーター

context

SettingsContext

現在のアプリケーションの使い方を記述している SettingsContext。

properties

SettingsPropertyCollection

値の取得対象となる設定プロパティ グループを格納している SettingsPropertyCollection。

実装

Upgrade(SettingsContext, SettingsPropertyCollection)

例外

ConfigurationErrorsException

ユーザー スコープの設定が見つかりましたが、現在の構成はアプリケーション スコープの設定しかサポートしていません。

- または -

構成ファイルの以前のバージョンにアクセスできませんでした。

注釈

LocalFileSettingsProvider では、個別の操作でローカルとローミングの設定が移行されます。

メソッドは Upgrade 、 が適用されているすべてのアプリケーション設定 NoSettingsVersionUpgradeAttribute 、または から ApplicationSettingsBase派生した設定ラッパー クラス全体に対して抑制されます。

この方法でこのメソッドを呼び出す方法は、アップグレードするアプリケーションの種類によって異なります。

• ClickOnce アプリケーションの各バージョンは、独自の分離インストール ディレクトリに格納されます。 ClickOnce アプリケーションの新しいバージョンがインストールされ、新しいバージョンが最初に実行されると、内部ロジックが自動的に を呼び出 Upgrade して、すべての一般的なアプリケーション設定を新しいバージョンに移行します。 詳細については、「ClickOnce とアプリケーション設定」を参照してください。

• 標準Windows フォームアプリケーションとコンソール アプリケーションでは、 を手動で呼び出すUpgrade必要があります。これは、このようなアプリケーションが最初に実行されるタイミングを判断する一般的な自動方法がないためです。 これを行う 2 つの一般的な方法は、インストール プログラムから、または永続化されたプロパティ (多くの場合、 のような IsFirstRun名前) を使用して、アプリケーション自体から を使用することです。

新しいバージョンでアプリケーション設定を移行するには、以前のバージョンのアプリケーション設定を読み込んで読み取ることができる必要があることに注意してください。 そのため、アプリケーションの新しいバージョンと以前のバージョンの両方と互換性のあるラッパー クラスを含める必要があります。

こちらもご覧ください

• GetPreviousVersion(SettingsContext, SettingsProperty)
• Reset(SettingsContext)
• IApplicationSettingsProvider
• NoSettingsVersionUpgradeAttribute