ConfigurationManager.GetSection メソッド

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

ConfigurationManager.GetSection メソッド

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

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim sectionName As String
Dim returnValue As Object

returnValue = ConfigurationManager.GetSection(sectionName)

C#

public static Object GetSection (
    string sectionName
)

C++

public:
static Object^ GetSection (
    String^ sectionName
)

J#

public static Object GetSection (
    String sectionName
)

JScript

public static function GetSection
 (
    sectionName : String
) : Object

パラメータ

sectionName

構成セクションのパスと名前。

戻り値
指定した ConfigurationSection オブジェクト。セクションが存在しない場合は null 参照 (Visual Basic では Nothing)。

例外

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

解説

クライアント アプリケーションの場合、このメソッドはアプリケーション構成ファイル、ローカル ユーザー構成ファイル、およびローミング構成ファイルをマージすることによって作成された構成ファイルを取得します。

GetSection メソッドは、このメソッドが変更できない実行時の構成情報にアクセスします。構成を変更するには、次の Open メソッドのいずれかを使用して取得した構成ファイルで GetSection メソッドを使用します。

• OpenExeConfiguration

• OpenMachineConfiguration

• OpenMappedExeConfiguration

• OpenMappedExeConfiguration

実装時の注意 戻り値を予想される構成の種類にキャストする必要があります。発生する可能性のあるキャストの例外を回避するには、C# の as 演算子や、Visual Basic の TryCast 関数など、条件付きキャスト演算を使用する必要があります。

使用例

GetSection メソッドを使用して、構成のカスタム セクションを作成し、アプリケーション構成ファイルに保存する方法を次のコード例に示します。

Visual Basic

' Get the a custom section. Show how to use the
' GetSection method.
Shared Sub GetCustomSection()
    ' Get the custom section.
    Dim custSection As CustomSection = _
    ConfigurationManager.GetSection("CustomSection")
    
    ' Read the custom section.
    Console.WriteLine( _
    "File name: {0} MaxIdleTime: {1} MaxUsers: {2}",
 _
    custSection.FileName, custSection.MaxIdleTime, _
    custSection.MaxUsers)
End Sub 'GetCustomSection

C#

// Get the a custom section. Show how to use the
// GetSection method.
static void GetCustomSection()
{
    // Get the custom section.
    CustomSection custSection = 
        ConfigurationManager.GetSection("CustomSection") as CustomSection;
    
    // Read the custom section.
    Console.WriteLine("File name: {0} MaxIdleTime: {1} MaxUsers: {2}",
        custSection.FileName, custSection.MaxIdleTime, 
        custSection.MaxUsers);

}

プラットフォーム

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 クラス
ConfigurationManager メンバ
System.Configuration 名前空間
ConfigurationSection