ConfigurationManager

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

ConfigurationManager クラス

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

クライアント アプリケーションの構成ファイルにアクセスできるようにします。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 ConfigurationManager

Visual Basic (使用法)

静的クラスのメンバは、クラスのインスタンスなしに直接アクセスされます。

C#

public static class ConfigurationManager

C++

public ref class ConfigurationManager abstract
 sealed

J#

public final class ConfigurationManager

JScript

public final class ConfigurationManager

解説

ConfigurationManager クラスを使用すると、マシン構成情報、アプリケーション構成情報、およびユーザー構成情報にアクセスできます。このクラスは ConfigurationSettings クラスに代わるもので、優先して使用されます。

クライアント アプリケーションはクライアント コンピュータで実行され、Web アプリケーションはクライアントの接続先であるサーバー コンピュータで実行されます。

System.Configuration の組み込みの型またはこれらの型から派生した型を使用して、構成情報を処理できます。これらの型を使用すると、構成情報を直接処理することが可能で、構成ファイルを拡張してカスタム情報を含めることもできます。

ConfigurationManager クラスには、次のタスクを実行できるメンバが含まれています。

• 構成ファイルからセクションを読み取ります。構成情報にアクセスするには、GetSection メソッドを呼び出します。appSettings や connectionStrings などの一部のセクションには、AppSettings クラスおよび ConnectionStrings クラスを使用します。これらのメンバは、読み取り専用の操作を実行し、構成のキャッシュされた 1 つのインスタンスを使用し、マルチスレッド対応です。

• 構成ファイル全体の読み取りと書き込みを行います。アプリケーションは、そのアプリケーション自体や他のアプリケーション、またはコンピュータのあらゆるレベルで、ローカルまたはリモートから構成設定の読み取りと書き込みを行うことができます。ConfigurationManager クラスに用意されているメソッドのいずれかを使用して、SampleApp.exe.config などの構成ファイルを開くことができます。これらのメソッドは、Configuration オブジェクトを返します。このオブジェクトは、関連付けられている構成ファイルの処理に使用できるメソッドとプロパティを公開します。メソッドは、読み取り操作または書き込み操作を実行し、ファイルに書き込みが行われるたびに構成データを再作成します。

• 構成タスクをサポートします。次の型を使用して、さまざまな構成タスクをサポートします。

  • SectionInformation

  • PropertyInformation

  • PropertyInformationCollection

  • ElementInformation

  • ContextInformation

  • ConfigurationSectionGroup

  • ConfigurationSectionGroupCollection

  既存の構成情報の処理に加え、ConfigurationElement、ConfigurationElementCollection、ConfigurationProperty、ConfigurationSection の各クラスなど、組み込みの構成の種類を拡張することによって、カスタム構成要素を作成し使用できます。組み込みの構成の種類をプログラムによって拡張する方法の例については、ConfigurationSection に関するトピックを参照してください。属性ベースのモデルを使用して、組み込みの構成の種類を拡張する方法の例については、ConfigurationElement に関するトピックを参照してください。

実装時の注意 Configuration クラスは、構成ファイルの編集をプログラムから行うことができるようにします。ConfigurationManager によって提供された、Open メソッドの 1 つを使用します。これらのメソッドは、Configuration オブジェクトを返します。このオブジェクトにより、基になる構成ファイルを処理するために必要なメソッドとプロパティが提供されます。これらのファイルへの読み取りアクセスまたは書き込みアクセスができます。 構成ファイルを読み取るには、GetSection または GetSectionGroup を使用して構成情報を読み取ります。読み取りを行うユーザーまたはプロセスに、次のアクセス許可が必要です。

• 現在の構成階層レベルの構成ファイルに対する読み取りアクセス許可。

• すべての親構成ファイルに対する読み取りアクセス許可。

アプリケーションが独自の構成に対する読み取り専用アクセスを行う必要がある場合は、GetSection メソッドを使用することをお勧めします。これらのメソッドにより、現在のアプリケーションのキャッシュされた構成値にアクセスできます。こちらの方が、Configuration クラスよりもパフォーマンスが優れています。 構成ファイルへの書き込みを行うには、Save メソッドのいずれかを使用します。書き込みを行うユーザーまたはプロセスに、次のアクセス許可が必要です。

• 現在の構成階層レベルの構成ファイルおよびディレクトリに対する書き込みアクセス許可。

• すべての構成ファイルに対する読み取りアクセス許可。

使用例

ConfigurationManager クラスを使用して、カスタム構成セクションにアクセスする方法を次のコード例に示します。セクションが存在しない場合は、セクションが作成され、構成ファイルに追加されます。この例で使用するカスタム セクション クラスは、ConfigurationPropertyAttribute クラスに含まれる例で実装されます。

Visual Basic

 ' Create a custom section.
Shared Sub New()
   ' Get the application configuration file.
     Dim config As System.Configuration.Configuration
 = _
     ConfigurationManager.OpenExeConfiguration( _
     ConfigurationUserLevel.None)
   ' Console.WriteLine(config.FilePath);
   ' If the section does not exiat in the configuration
   ' file, create it and save it to the file.
   If config.Sections(customSectionName) Is
 Nothing Then
      custSection = New CustomSection()
      config.Sections.Add(customSectionName, custSection)
      custSection = config.GetSection(customSectionName)
      custSection.SectionInformation.ForceSave = True
      config.Save(ConfigurationSaveMode.Full)
   End If
End Sub 'New

C#

// Create a custom section.
static UsingConfigurationManager()
{
    // Get the application configuration file.
    System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);
 
    // If the section does not exist in the configuration
    // file, create it and save it to the file.
    if (config.Sections[customSectionName] == null)
    {
        custSection = new CustomSection();
        config.Sections.Add(customSectionName, custSection);
        custSection =
            config.GetSection(customSectionName) as CustomSection;
        custSection.SectionInformation.ForceSave = true;
        config.Save(ConfigurationSaveMode.Full);
    }
}

この例では、次の構成ファイルに示される要素を処理します。この構成ファイルは、このコード例を初めて実行したときに生成されます。

メモ
バージョン管理の要件を反映するには、Version 属性を設定する必要があります。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="CustomSection" 
       type="Samples.Config.CustomSection,
         ConfigurationManager, 
         Version=1.0.0.0, 
         Culture=neutralPublicKeyToken=null" 
         allowDefinition="Everywhere" 
         allowExeDefinition="MachineToApplication" 
         restartOnExternalChanges="true" />
  </configSections>
  <connectionStrings>
    <add name="ConnStr1" 
      connectionString="LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;Initial
 Catalog=aspnetdb"
      providerName="System.Data.SqlClient" />
    <add name="ConnStr2" 
      connectionString="LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;Initial
 Catalog=aspnetdb"
      providerName="System.Data.SqlClient" />
  </connectionStrings>
  <appSettings>
    <add key="AppSetting0" 
      value="Monday, February 28, 2005 1:27:59 PM" />
    <add key="AppSetting1" 
      value="Monday, February 28, 2005 1:36:40 PM" />
  </appSettings>
  <CustomSection fileName="default.txt" maxUsers="1000" 
     maxIdleTime="00:10:00" />
</configuration>

継承階層

System.Object
  System.Configuration.ConfigurationManager

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
ConfigurationManager メンバ
System.Configuration 名前空間
Configuration クラス
WebConfigurationManager
その他の技術情報
アプリケーションの設定

ConfigurationManager プロパティ

パブリック プロパティ

	名前	説明
	AppSettings	現在のアプリケーションの既定構成の AppSettingsSection データを取得します。
	ConnectionStrings	現在のアプリケーションの既定構成の ConnectionStringsSection データを取得します。

参照

関連項目

ConfigurationManager クラス
System.Configuration 名前空間
Configuration クラス
WebConfigurationManager

その他の技術情報

アプリケーションの設定

ConfigurationManager メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetSection	現在のアプリケーションの既定構成の、指定した構成セクションを取得します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	OpenExeConfiguration	オーバーロードされます。 指定したクライアント構成ファイルを Configuration オブジェクトとして開きます。
	OpenMachineConfiguration	現在のコンピュータのマシン構成ファイルを Configuration オブジェクトとして開きます。
	OpenMappedExeConfiguration	指定したファイル マップとユーザー レベルを使用して、指定したクライアント構成ファイルを Configuration オブジェクトとして開きます。
	OpenMappedMachineConfiguration	指定したファイル マップを使用して、マシン構成ファイルを Configuration オブジェクトとして開きます。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	RefreshSection	名前付きセクションを次回取得するときに、ディスクから再読み取りするように、名前付きセクションを更新します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

ConfigurationManager クラス
System.Configuration 名前空間
Configuration クラス
WebConfigurationManager

その他の技術情報

アプリケーションの設定

ConfigurationManager メンバ

クライアント アプリケーションの構成ファイルにアクセスできるようにします。このクラスは継承できません。

ConfigurationManager データ型で公開されるメンバを以下の表に示します。

パブリック プロパティ

	名前	説明
	AppSettings	現在のアプリケーションの既定構成の AppSettingsSection データを取得します。
	ConnectionStrings	現在のアプリケーションの既定構成の ConnectionStringsSection データを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetSection	現在のアプリケーションの既定構成の、指定した構成セクションを取得します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	OpenExeConfiguration	オーバーロードされます。 指定したクライアント構成ファイルを Configuration オブジェクトとして開きます。
	OpenMachineConfiguration	現在のコンピュータのマシン構成ファイルを Configuration オブジェクトとして開きます。
	OpenMappedExeConfiguration	指定したファイル マップとユーザー レベルを使用して、指定したクライアント構成ファイルを Configuration オブジェクトとして開きます。
	OpenMappedMachineConfiguration	指定したファイル マップを使用して、マシン構成ファイルを Configuration オブジェクトとして開きます。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	RefreshSection	名前付きセクションを次回取得するときに、ディスクから再読み取りするように、名前付きセクションを更新します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

ConfigurationManager クラス
System.Configuration 名前空間
Configuration クラス
WebConfigurationManager

その他の技術情報

アプリケーションの設定

ウィキペディア小見出し辞書

Configuration Manager

出典: フリー百科事典『ウィキペディア（Wikipedia）』 (2022/06/09 07:26 UTC 版)

「Windows NT系」の記事における「Configuration Manager」の解説

レジストリを管理するコンポーネント。