WebConfigurationManager.GetWebApplicationSection メソッド

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

WebConfigurationManager.GetWebApplicationSection メソッド

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

現在の Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。

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

Visual Basic (宣言)

Public Shared Function GetWebApplicationSection
 ( _
    sectionName As String _
) As Object

Visual Basic (使用法)

Dim sectionName As String
Dim returnValue As Object

returnValue = WebConfigurationManager.GetWebApplicationSection(sectionName)

C#

public static Object GetWebApplicationSection
 (
    string sectionName
)

C++

public:
static Object^ GetWebApplicationSection (
    String^ sectionName
)

J#

public static Object GetWebApplicationSection
 (
    String sectionName
)

JScript

public static function GetWebApplicationSection
 (
    sectionName : String
) : Object

パラメータ

sectionName

構成セクション名。

戻り値
指定した構成セクション オブジェクト。指定したセクションが存在しない場合は null 参照 (Visual Basic では Nothing)。このセクションに実行時にアクセスできない場合は内部オブジェクト。

例外

例外の種類	条件
ConfigurationErrorsException	有効な構成ファイルを読み込むことができませんでした。

解説

GetWebApplicationSection は、Web アプリケーション内で呼び出された場合、Web アプリケーション構成階層に基づいて、システムによって選択された構成ファイルからセクションを取得します。

GetWebApplicationSection は、クライアント アプリケーション内から呼び出すことができます。この場合、クライアント構成階層に基づいてシステムによって選択された構成ファイルから既定のセクションを取得します。通常は Machine.config ファイルになりますが、割り当てられた構成が配置されている場合は除きます。構成ファイルの割り当てについては、次で説明する割り当て方法を参照してください。

メモ
GetWebApplicationSection は実行時の操作で、現在のレベルに存在するアプリケーション構成ファイルのセクションに対して動作します。一方、GetSection メソッドは実行時の操作ではありませんが、構成ファイルを開くためのメソッドのいずれかを使用して取得された、指定したセクションに対して動作します。

実装時の注意 戻り値は、使用前に適切な構成の種類にキャストする必要があります。キャスト例外の発生を防ぐため、C# の as 演算子や Visual Basic の TryCast 関数などの、条件キャスト操作を使用してください。

使用例

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

Visual Basic

' Show the use of GetWebApplicationSection(string). 
' If called from within a Web aplication it gets the
' section from the configuration file located at the 
' application current level.
' Its behavior is similar to GetSection(string)
Shared Sub GetWebApplicationSection()
   
   ' Get the default connectionStrings section,
     Dim connectionStringsSection As ConnectionStringsSection
 = _
     WebConfigurationManager.GetWebApplicationSection( _
     "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 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 'GetWebApplicationSection

C#

// Show the use of GetWebApplicationSection(string). 
// If called from within a Web aplication it gets the
// section from the configuration file located at the 
// application current level.
// Its behavior is similar to GetSection(string)
static void GetWebApplicationSection()
{

    // Get the default connectionStrings section,
    ConnectionStringsSection connectionStringsSection =
        WebConfigurationManager.GetWebApplicationSection(
        "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 connectionStrings]");
    while (connectionStringsEnum.MoveNext())
    {
        string name = connectionStrings[i].Name;
        Console.WriteLine("Name: {0} Value: {1}",
        name, connectionStrings[name]);
        i += 1;
    }

    Console.WriteLine();
}

プラットフォーム

Windows 98, Windows 2000 SP4, 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

参照

関連項目
WebConfigurationManager クラス
WebConfigurationManager メンバ
System.Web.Configuration 名前空間
ConfigurationSection