Configuration.GetSection(String) Method

Reference

Definition

Namespace:: System.Configuration

Assembly:: System.Configuration.ConfigurationManager.dll

Assembly:: System.Configuration.dll

Package:: System.Configuration.ConfigurationManager v9.0.0

Source:: Configuration.cs

Source:: Configuration.cs

Source:: Configuration.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the specified ConfigurationSection object.

public:
 System::Configuration::ConfigurationSection ^ GetSection(System::String ^ sectionName);

public System.Configuration.ConfigurationSection GetSection (string sectionName);

member this.GetSection : string -> System.Configuration.ConfigurationSection

Public Function GetSection (sectionName As String) As ConfigurationSection

Parameters

sectionName: String

The path to the section to be returned.

Returns

ConfigurationSection

The specified ConfigurationSection object, or null if the requested section does not exist.

Examples

The following example shows how to use the GetSection method to access a custom section. For the complete example code that defines a class that stores information for the CustomSection section, see the Configuration class overview.

// Show how to use the GetSection(string) method.
static void GetCustomSection()
{
    try
    {

        CustomSection customSection;

        // Get the current configuration file.
        System.Configuration.Configuration config =
                ConfigurationManager.OpenExeConfiguration(
                ConfigurationUserLevel.None) as Configuration;

        customSection =
            config.GetSection("CustomSection") as CustomSection;

        Console.WriteLine("Section name: {0}", customSection.Name);
        Console.WriteLine("Url: {0}", customSection.Url);
        Console.WriteLine("Port: {0}", customSection.Port);
    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine("Using GetSection(string): {0}", err.ToString());
    }
}

' Show how to use the GetSection(string) method.
Public Shared Sub GetCustomSection()
    Try

        Dim customSection As CustomSection

        ' Get the current configuration file.
        Dim config As System.Configuration.Configuration = TryCast(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None), Configuration)

        customSection = TryCast(config.GetSection("CustomSection"), CustomSection)

        Console.WriteLine("Section name: {0}", customSection.Name)
        Console.WriteLine("Url: {0}", customSection.Url)
        Console.WriteLine("Port: {0}", customSection.Port)

    Catch err As ConfigurationErrorsException
        Console.WriteLine("Using GetSection(string): {0}", err.ToString())
    End Try

End Sub

Remarks

Configuration settings are contained within sections that group similar settings together for convenience. The GetSection method retrieves a configuration section by its name.

Applies to

Share via