ConfigurationManager.GetSection(String) Метод

Определение

Пространство имен:

System.Configuration

Сборка:

System.Configuration.ConfigurationManager.dll

Пакет:

System.Configuration.ConfigurationManager v11.0.0-preview.7.26381.103

Исходный код:

ConfigurationManager.cs

Извлекает указанный раздел конфигурации для конфигурации текущего приложения по умолчанию.

public:
 static System::Object ^ GetSection(System::String ^ sectionName);

public static object GetSection(string sectionName);

static member GetSection : string -> obj

Public Shared Function GetSection (sectionName As String) As Object

Параметры

sectionName

String

Путь к разделу конфигурации и имя. Имена узлов разделены косой чертой вперед, например "system.net/mailSettings/smtp".

Возвращаемое значение

Object

Указанный ConfigurationSection объект или null если раздел не существует.

Исключения

ConfigurationErrorsException

Не удалось загрузить файл конфигурации.

Примеры

В следующем примере показано, как использовать GetSection метод. Пример является частью более крупного примера, предоставленного ConfigurationManager для класса.

// Create the AppSettings section.
// The function uses the GetSection(string)method 
// to access the configuration section. 
// It also adds a new element to the section collection.
public static void CreateAppSettings()
{
  // Get the application configuration file.
  System.Configuration.Configuration config =
    ConfigurationManager.OpenExeConfiguration(
          ConfigurationUserLevel.None);

  string sectionName = "appSettings";

  // Add an entry to appSettings.
  int appStgCnt =
      ConfigurationManager.AppSettings.Count;
  string newKey = "NewKey" + appStgCnt.ToString();

  string newValue = DateTime.Now.ToLongDateString() + 
    " " + DateTime.Now.ToLongTimeString();

  config.AppSettings.Settings.Add(newKey, newValue);

  // Save the configuration file.
  config.Save(ConfigurationSaveMode.Modified);
  
  // Force a reload of the changed section. This 
  // makes the new values available for reading.
  ConfigurationManager.RefreshSection(sectionName);

  // Get the AppSettings section.
  AppSettingsSection appSettingSection =
    (AppSettingsSection)config.GetSection(sectionName);

  Console.WriteLine();
  Console.WriteLine("Using GetSection(string).");
  Console.WriteLine("AppSettings section:");
  Console.WriteLine(
    appSettingSection.SectionInformation.GetRawXml());
}

' Create the AppSettings section.
' The function uses the GetSection(string)method 
' to access the configuration section. 
' It also adds a new element to the section collection.
Public Shared Sub CreateAppSettings()
    ' Get the application configuration file.
    Dim config As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
        ConfigurationUserLevel.None)

    Dim sectionName As String = "appSettings"

    ' Add an entry to appSettings.
    Dim appStgCnt As Integer = _
        ConfigurationManager.AppSettings.Count
    Dim newKey As String = _
        "NewKey" + appStgCnt.ToString()

    Dim newValue As String = _
        DateTime.Now.ToLongDateString() + " " + _
        DateTime.Now.ToLongTimeString()

    config.AppSettings.Settings.Add(newKey, _
                                    newValue)

    ' Save the configuration file.
    config.Save(ConfigurationSaveMode.Modified)

    ' Force a reload of the changed section. This 
    ' makes the new values available for reading.
    ConfigurationManager.RefreshSection(sectionName)

    ' Get the AppSettings section.
    Dim appSettingSection As AppSettingsSection = _
        DirectCast(config.GetSection(sectionName),  _
        AppSettingsSection)

    Console.WriteLine()
    Console.WriteLine( _
        "Using GetSection(string).")
    Console.WriteLine( _
        "AppSettings section:")
    Console.WriteLine( _
        appSettingSection.SectionInformation.GetRawXml())
End Sub

Комментарии

Для клиентских приложений этот метод получает файл конфигурации, полученный путем объединения файла конфигурации приложения, файла конфигурации локального пользователя и перемещаемого файла конфигурации.

Метод GetSection обращается к сведениям о конфигурации во время выполнения, которые он не может изменить. Чтобы изменить конфигурацию, используйте GetSection метод в файле конфигурации, который вы получаете с помощью одного из следующих методов:

• OpenExeConfiguration

• OpenMachineConfiguration

• OpenMappedExeConfiguration

Примечания для тех, кто наследует этот метод

Необходимо привести возвращаемое значение к ожидаемому типу конфигурации. Чтобы избежать возможных исключений приведения, следует использовать операцию условного приведения, например оператор as в C# или функцию TryCast в Visual Basic.

См. также раздел

• ConfigurationSection