WebConfigurationManager クラスとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

WebConfigurationManager クラス

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

Web アプリケーションに適用される構成ファイルにアクセスできるようにします。

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

Visual Basic (宣言)

Public NotInheritable Class
 WebConfigurationManager

Visual Basic (使用法)

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

public static class WebConfigurationManager

C++

public ref class WebConfigurationManager abstract
 sealed

public final class WebConfigurationManager

JScript

public final class WebConfigurationManager

解説

WebConfigurationManager を使用すると、マシン情報やアプリケーション情報にアクセスできます。

次に説明するように、作成したアプリケーションで System.Configuration 型を拡張したり、それを直接使用して構成情報を処理したりできます。

構成の処理。標準型を使用して構成情報を処理するには、次のいずれかの方法を使用します。
- セクションへのアクセス。アプリケーションの構成情報にアクセスするには、WebConfigurationManager によって提供された GetSection メソッドのいずれかを使用する必要があります。appSettings と connectionStrings の場合は、AppSettings プロパティと ConnectionStrings プロパティを使用します。これらのメソッドは、読み取り専用の操作を実行し、構成のキャッシュされた 1 つのインスタンスを使用し、マルチスレッド対応です。
- 構成ファイルへのアクセス。アプリケーションは、そのアプリケーション自体や他のアプリケーション、またはコンピュータのあらゆるレベルで、ローカルまたはリモートから構成設定の読み取りと書き込みを行うことができます。WebConfigurationManager によって提供された open メソッドの 1 つを使用します。これらのメソッドは、Configuration オブジェクトを返します。このオブジェクトにより、基になる構成ファイルを処理するために必要なメソッドとプロパティが提供されます。これらのメソッドは、読み取り操作または書き込み操作を実行し、ファイルが開かれるたびに構成データを再作成します。
- 詳細な構成。より詳細な構成処理は、SectionInformation、PropertyInformation、PropertyInformationCollection、ElementInformation、ContextInformation、ConfigurationSectionGroup、ConfigurationSectionGroupCollection、および WebConfigurationSectionGroup の各型によって提供されます。
構成の標準型の拡張。ConfigurationElement、ConfigurationElementCollection、ConfigurationProperty、および ConfigurationSection などの標準の構成を、プログラムや属性モデルを使用して拡張して、カスタム構成要素を提供することもできます。構成の標準型をプログラムを使用して拡張する方法の例については、ConfigurationSection のトピックを参照してください。構成の標準型を属性モデルを使用して拡張する方法の例については、ConfigurationElement のトピックを参照してください。

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

読み取り。構成情報を読み取るには、GetSection または GetSectionGroup を使用します。読み取りを行うユーザーまたはプロセスに、次のアクセス許可が必要です。
- 現在の構成階層レベルの構成ファイルに対する読み取りアクセス許可。
- すべての親構成ファイルに対する読み取りアクセス許可。

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

メモ
パスパラメータを受け取る静的な GetSection メソッドを使用する場合、パスパラメータは、コードを実行しているアプリケーションを参照している必要があります。そうでない場合は、パラメータが無視され、現在実行中のアプリケーションの構成情報が返されます。

書き込み。構成情報を書き込むには、Save メソッドの 1 つを使用します。書き込みを行うユーザーまたはプロセスに、次のアクセス許可が必要です。
- 現在の構成階層レベルの構成ファイルおよびディレクトリに対する書き込みアクセス許可。
- すべての構成ファイルに対する読み取りアクセス許可。

Topic	Location
方法 : ASP.NET 構成設定をロックする	ASP .NET Web アプリケーションの構成
方法 : プログラムによって ASP.NET 構成設定にアクセスする	ASP .NET Web アプリケーションの構成
方法 : 継承された構成設定とローカルな構成設定をプログラムから表示する	ASP .NET Web アプリケーションの構成

使用例

WebConfigurationManager メソッドを使用して構成情報にアクセスする方法を次のコード例に示します。

Visual Basic

' Show the use of GetSection(string). 
' It gets the connectiobStrings section.
' If called from within a client application,
' the GetSection(string) gets the default connectionStrings
' section from the machine.config.
' If called from within a Web aplication it gets the
' section from the configuration file located at the 
' application current level. 
Shared Sub GetSection1()
   
   ' Get the connectionStrings section.
     Dim connectionStringsSection As ConnectionStringsSection
 = _
     WebConfigurationManager.GetSection("connectionStrings")
   
   ' Get the connectionStrings key,value pairs collection.
     Dim connectionStrings As ConnectionStringSettingsCollection
 = _
     connectionStringsSection.ConnectionStrings
   
   ' Get the collection enumerator.
     Dim connectionStringsEnum As IEnumerator
 = _
     connectionStrings.GetEnumerator()
   
   ' Loop through the collection and 
   ' display the connectionStrings key, value pairs.
   Dim i As Integer = 0
   Console.WriteLine("[Display the connectionStrings]")
   While connectionStringsEnum.MoveNext()
      Dim name As String
 = connectionStrings(i).Name
         Console.WriteLine("Name: {0} Value: {1}",
 _
         name, connectionStrings(name))
      i += 1
   End While
   
   Console.WriteLine()
End Sub 'GetSection1

// Show the use of GetSection(string). 
// It gets the connectiobStrings section.
// If called from within a client application,
// the GetSection(string) gets the default connectionStrings
// section from the machine.config.
// If called from within a Web aplication it gets the
// section from the configuration file located at the 
// application current level. 
static void GetSection1()
{

    // Get the connectionStrings section.
    ConnectionStringsSection connectionStringsSection =
        WebConfigurationManager.GetSection("connectionStrings")
        as ConnectionStringsSection;

    // Get the connectionStrings key,value pairs collection.
    ConnectionStringSettingsCollection connectionStrings =
        connectionStringsSection.ConnectionStrings;
   
    // Get the collection enumerator.
    IEnumerator connectionStringsEnum =
        connectionStrings.GetEnumerator();

    // Loop through the collection and 
    // display the connectionStrings key, value pairs.
    int i = 0;
    Console.WriteLine("[Display the connectionStrings]");
    while (connectionStringsEnum.MoveNext())
    {
        string name = connectionStrings[i].Name;
        Console.WriteLine("Name: {0} Value: {1}",
        name, connectionStrings[name]);
        i += 1;
    }

    Console.WriteLine();
}