ConfigurationManager.GetSection(String) Método

Definición

Espacio de nombres:

System.Configuration

Ensamblado:

System.Configuration.ConfigurationManager.dll

Paquete:

System.Configuration.ConfigurationManager v8.0.0

Source:

ConfigurationManager.cs

Recupera una sección de configuración especificada para la configuración predeterminada de la aplicación actual.

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

Parámetros

sectionName

String

Ruta de acceso y nombre de la sección de configuración. Los nombres de los nodos están separados por barras diagonales, por ejemplo "system.net/mailSettings/smtp".

Devoluciones

Object

Objeto ConfigurationSection especificado o null si la sección no existe.

Excepciones

ConfigurationErrorsException

No se pudo cargar un archivo de configuración.

Ejemplos

En el siguiente ejemplo, se muestra cómo utilizar el método GetSection. El ejemplo forma parte de un ejemplo más grande que se proporciona para la ConfigurationManager clase .

// 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

Comentarios

En el caso de las aplicaciones cliente, este método recupera un archivo de configuración obtenido mediante la combinación del archivo de configuración de la aplicación, el archivo de configuración de usuario local y el archivo de configuración móvil.

El GetSection método obtiene acceso a la información de configuración en tiempo de ejecución que no puede cambiar. Para cambiar la configuración, use el GetSection método en el archivo de configuración que se obtiene mediante uno de los métodos siguientes:

• OpenExeConfiguration

• OpenMachineConfiguration

• OpenMappedExeConfiguration

Notas a los desarrolladores de herederos

Debe convertir el valor devuelto al tipo de configuración esperado. Para evitar posibles excepciones de conversión, debe usar una operación de conversión condicional como el as operador en C# o la función TryCast en Visual Basic.

Consulte también

• ConfigurationSection