ConfigurationManager.GetSection(String) Método

Definición

Recupera una sección de configuración especificada para la configuración predeterminada de la aplicación actual.Retrieves a specified configuration section for the current application's default configuration.

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.The configuration section path and name. Los nombres de los nodos están separados por barras diagonales, por ejemplo "system.net/mailSettings/smtp".Node names are separated by forward slashes, for example "system.net/mailSettings/smtp".

Devoluciones

Objeto ConfigurationSection especificado o null si la sección no existe.The specified ConfigurationSection object, or null if the section does not exist.

Excepciones

No se pudo cargar un archivo de configuración.A configuration file could not be loaded.

Ejemplos

En el siguiente ejemplo, se muestra cómo utilizar el método GetSection.The following example shows how to use the GetSection method. El ejemplo forma parte de un ejemplo más grande que se proporciona para la clase ConfigurationManager.The example is part of a larger example that is provided for the ConfigurationManager class.

// 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 que se obtiene al combinar el archivo de configuración de la aplicación, el archivo de configuración del usuario local y el archivo de configuración de itinerancia.For client applications, this method retrieves a configuration file obtained by merging the application configuration file, the local user configuration file, and the roaming configuration file.

El método GetSection tiene acceso a la información de configuración en tiempo de ejecución que no puede cambiar.The GetSection method accesses run-time configuration information that it cannot change. Para cambiar la configuración, use el método GetSection del archivo de configuración que obtiene mediante uno de los siguientes métodos abiertos:To change the configuration, you use the GetSection method on the configuration file that you obtain by using one of the following Open methods:

Notas a los desarrolladores de herederos

Debe convertir el valor devuelto al tipo de configuración esperado.You must cast the return value to the expected configuration type. Para evitar posibles excepciones de conversión, debe utilizar una operación de conversión condicional como el operador as en C# o la función TryCast en Visual Basic.To avoid possible casting exceptions, you should use a conditional casting operation such as the as operator in C# or the TryCast function in Visual Basic.

Se aplica a

Consulte también: