LocalFileSettingsProvider.Upgrade メソッド

.NET Framework クラス ライブラリ リファレンス

LocalFileSettingsProvider.Upgrade メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Configuration
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As LocalFileSettingsProvider
Dim context As SettingsContext
Dim properties As SettingsPropertyCollection

instance.Upgrade(context, properties)

C#

public void Upgrade (
    SettingsContext context,
    SettingsPropertyCollection properties
)

C++

public:
virtual void Upgrade (
    SettingsContext^ context, 
    SettingsPropertyCollection^ properties
) sealed

J#

public final void Upgrade (
    SettingsContext context, 
    SettingsPropertyCollection properties
)

JScript

public final function Upgrade (
    context : SettingsContext, 
    properties : SettingsPropertyCollection
)

パラメータ

context

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

properties

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

例外

例外の種類	条件
ConfigurationErrorsException	ユーザー スコープの設定が見つかりましたが、現在の構成はアプリケーション スコープの設定しかサポートしていません。 または 構成ファイルの以前のバージョンにアクセスできませんでした。

解説

LocalFileSettingsProvider は、ローカル設定と移動設定を別個の操作で移行します。

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

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

• ClickOnce アプリケーションの各バージョンは、それぞれ別のインストール ディレクトリに格納されます。ClickOnce アプリケーションの新しいバージョンをインストールした後、その新しいバージョンを初めて実行するときに、内部ロジックによって Upgrade が自動的に呼び出され、共通するすべてのアプリケーション設定が新しいバージョンに移行されます。詳細については、「ClickOnce とアプリケーション設定」を参照してください。

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

新しいバージョンでアプリケーション設定を移行する場合、そのバージョンで、アプリケーション設定の以前のバージョンの読み込みと読み取りが可能であることが必要となります。したがって、新しいバージョンには、アプリケーションの新しいバージョンと以前のバージョンの両方と互換性のあるラッパー クラスが含まれている必要があります。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
LocalFileSettingsProvider クラス
LocalFileSettingsProvider メンバ
System.Configuration 名前空間
GetPreviousVersion
Reset
IApplicationSettingsProvider インターフェイス
NoSettingsVersionUpgradeAttribute