WebConfigurationManager クラス

定義

名前空間:

System.Web.Configuration

アセンブリ:

System.Web.dll

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

public ref class WebConfigurationManager abstract sealed

public static class WebConfigurationManager

type WebConfigurationManager = class

Public Class WebConfigurationManager

継承

Object

WebConfigurationManager

例

次の例は、 を使用して構成情報にアクセスする方法を示しています。

GetSection メソッド

// Show how to use the GetSection(string). 
// to access the connectionStrings section.
static void GetConnectionStringsSection()
{

    // 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();
}

' Show how to use the GetSection(string). 
' to access the connectionStrings section.
Shared Sub GetConnectionStringsSection()
   
   ' 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

注釈

WebConfigurationManagerクラスを使用すると、コンピューターとアプリケーションの情報にアクセスできます。

Web アプリケーションに関連する構成ファイルを操作するには、 を使用 WebConfigurationManager することをお勧めします。 クライアント アプリケーションの場合は、 クラスを使用します ConfigurationManager 。

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

• Handling configuration. 標準の種類を使用して構成情報を処理するには、次のいずれかの方法を使用します。

  • Accessing a section. アプリケーションの構成情報にアクセスするには、 によってWebConfigurationManager提供されるGetSectionメソッドのいずれかを使用する必要があります。 と の<appSettings>場合は、 プロパティと ConnectionStrings プロパティを使用しますAppSettings。<connectionStrings> これらのメソッドは、読み取り専用操作を実行し、構成の単一のキャッシュされたインスタンスを使用し、マルチスレッド対応です。

  • Accessing configuration files. アプリケーションは、任意のレベル、それ自体、またはローカルまたはリモートの他のアプリケーションまたはコンピューターの構成設定の読み取りと書き込みを行うことができます。 によってWebConfigurationManager提供されるopenメソッドのいずれかを使用します。 これらのメソッドは オブジェクトを Configuration 返します。これにより、基になる構成ファイルを処理するために必要なメソッドとプロパティが提供されます。 これらのメソッドは、読み取りまたは書き込み操作を実行し、ファイルが開かれるたびに構成データを再作成します。

  • Advanced configuration. より高度な構成処理は、、、 ConfigurationSectionGroupPropertyInformationConfigurationSectionGroupCollectionPropertyInformationCollectionContextInformationElementInformationの各型SectionInformationによって提供されます。

• Extending configuration standard types. また、、 などのConfigurationElementConfigurationElementCollectionConfigurationPropertyConfigurationSection標準構成の種類を拡張し、プログラムまたは属性付きモデルを使用してカスタム構成要素を提供することもできます。 標準構成の種類を ConfigurationSection プログラムで拡張する方法の例については、 クラスを参照してください。 属性付きモデルを ConfigurationElement 使用して標準構成の種類を拡張する方法の例については、 クラスを参照してください。

注意 (継承者)

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

または GetSectionGroup(String) を使用GetSection(String)して、構成情報を読み取る。 読み取りを行うユーザーまたはプロセスには、次のアクセス許可が必要です。

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

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

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

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

構成情報を Save 書き込むには、いずれかの方法を使用します。 書き込みを行うユーザーまたはプロセスには、次のアクセス許可が必要です。

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

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

プロパティ

AppSettings	Web サイトのアプリケーション設定を取得します。
ConnectionStrings	Web サイトの接続文字列を取得します。

メソッド

GetSection(String)	現在の Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。
GetSection(String, String)	指定された場所にある Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。
GetWebApplicationSection(String)	現在の Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。
OpenMachineConfiguration()	現在のコンピューター上のマシン構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMachineConfiguration(String)	現在のコンピューター上のマシン構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMachineConfiguration(String, String)	指定したサーバー上の指定したマシン構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMachineConfiguration(String, String, IntPtr)	セキュリティ コンテキストを使用して、指定したサーバー上の指定したマシン構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMachineConfiguration(String, String, String, String)	セキュリティ コンテキストを使用して、指定したサーバー上の指定したマシン構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMappedMachineConfiguration(ConfigurationFileMap)	指定したファイル マップを使用して、マシン構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMappedMachineConfiguration(ConfigurationFileMap, String)	指定したファイル マップと場所を使用して、マシン構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMappedWebConfiguration(WebConfigurationFileMap, String)	指定したファイル マップと仮想パスを使用して、指定した Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String)	指定したファイル マップ、仮想パス、およびサイト名を使用して、指定した Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String, String)	指定したファイル マップ、仮想パス、サイト名、および場所を使用して、指定した Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenWebConfiguration(String)	指定した仮想パスを使用して、Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenWebConfiguration(String, String)	指定した仮想パスとサイト名を使用して、Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenWebConfiguration(String, String, String)	指定した仮想パス、サイト名、および場所を使用して、Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenWebConfiguration(String, String, String, String)	指定した仮想パス、サイト名、場所、およびサーバーを使用して、Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenWebConfiguration(String, String, String, String, IntPtr)	指定した仮想パス、サイト名、場所、サーバー、およびセキュリティ コンテキストを使用して、Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。
OpenWebConfiguration(String, String, String, String, String, String)	指定した仮想パス、サイト名、場所、サーバー、およびセキュリティ コンテキストを使用して、Web アプリケーション構成ファイルを Configuration オブジェクトとして開き、読み取りまたは書き込みができるようにします。

こちらもご覧ください

• Configuration
• ConfigurationManager
• ASP.NET 構成の概要