Esta documentación está archivada y no tiene mantenimiento.

WebConfigurationManager (Clase)

Proporciona acceso a los archivos de configuración cuando se aplican a las aplicaciones Web.

Espacio de nombres: System.Web.Configuration
Ensamblado: System.Web (en system.web.dll)

public static class WebConfigurationManager
public final class WebConfigurationManager
public final class WebConfigurationManager
No aplicable.

La clase WebConfigurationManager permite tener acceso a información del equipo y de la aplicación.

Utilizar WebConfigurationManager es la mejor manera de trabajar con archivos de configuración relacionada con las aplicaciones Web. Para las aplicaciones cliente, utilice la clase ConfigurationManager.

Su aplicación puede extender los tipos System.Configuration o utilizarlos directamente para controlar información de configuración, como se explica en la siguiente lista.

  • Handling configuration. Para controlar información de configuración mediante los tipos estándar, utilice uno de los enfoques siguientes:

    • Accessing a section. Para tener acceso a información de configuración de la aplicación, debe utilizar uno de los métodos GetSection proporcionado por WebConfigurationManager. Para <appSettings> y <connectionStrings>, utilice las propiedades AppSettings y ConnectionStrings. Estos métodos llevan a cabo operaciones de sólo lectura, utilizan una única instancia almacenada en memoria caché de la configuración y reconocen los multiprocesos.

    • Accessing configuration files. La aplicación lee y escribe las opciones de configuración en cualquier nivel, para sí o para otras aplicaciones o equipos, de forma local o remota. Se utiliza uno de los métodos open proporcionados por WebConfigurationManager. Estos métodos devuelven un objeto Configuration que, a su vez, proporciona los métodos y propiedades necesarios para controlar los archivos de configuración subyacentes. Estos métodos llevan a cabo operaciones de lectura o escritura y vuelven a crear los datos de configuración cada vez que se abre un archivo.

    • Advanced configuration. Los tipos SectionInformation, PropertyInformation, PropertyInformationCollection, ElementInformation, ContextInformation, ConfigurationSectionGroup y ConfigurationSectionGroupCollection proporcionan un control de configuración más avanzado.

  • Extending configuration standard types. También puede proporcionar sus elementos de configuración personalizados si extiende los tipos de configuración estándar como ConfigurationElement, ConfigurationElementCollection, ConfigurationProperty y ConfigurationSection mediante un modelo de programación o un modelo con atributos. Para obtener un ejemplo de cómo extender mediante programación un tipo de configuración estándar, vea la clase ConfigurationSection. Para obtener un ejemplo de cómo extender un tipo de configuración estándar mediante el modelo con atributos, vea la clase ConfigurationElement.

Notas para los implementadores: La clase Configuration permite el acceso mediante programación para editar archivos de configuración. Se utiliza uno de los métodos abiertos proporcionados por WebConfigurationManager. Estos métodos devolverán un objeto Configuration, que a su vez proporciona los métodos y propiedades necesarios para controlar los archivos de configuración subyacentes. Puede tener acceso a estos archivos para leer o escribir como se indica a continuación: Para leer la información de configuración se utiliza GetSection o GetSectionGroup. Tenga en cuenta que el usuario o el proceso que realiza la lectura debe tener los permisos siguientes:

  • Permiso de lectura en el archivo de configuración en el nivel actual de jerarquía de configuración.

  • Permisos de lectura en todos los archivos de configuración primarios.

Si la aplicación necesita disponer de acceso de sólo lectura a su propia configuración, se recomienda utilizar los métodos de GetSection. Estos métodos proporcionan a la aplicación actual acceso a los valores de configuración almacenados en caché, cuyo rendimiento es mejor que el de la clase Configuration.
NotaNota:

Si utiliza un método GetSection estático que acepta un parámetro path, dicho parámetro debe hacer referencia a la aplicación en la que se esté ejecutando el código; de lo contrario, se omitirá el parámetro y se devolverá la información de configuración de la aplicación que se esté ejecutando en ese momento.

Para escribir información de configuración se utiliza uno de los métodos de Save. Tenga en cuenta que el usuario o el proceso que realiza la escritura debe tener los permisos siguientes:
  • Permiso de escritura en el archivo de configuración y el directorio del nivel actual de jerarquía de configuración.

  • Permisos de lectura en todos los archivos de configuración.

En el ejemplo de código siguiente se muestra cómo obtener acceso a la información de configuración con el método WebConfigurationManager.


// Show the use of GetSection(string). 
// It gets the connectiobStrings section.
// If called from within a client application,
// the GetSection(string) gets the default connectionStrings
// section from the machine.config.
// If called from within a Web aplication it gets the
// section from the configuration file located at the 
// application current level. 
static void GetSection1()
{

    // Get the connectionStrings section.
    ConnectionStringsSection connectionStringsSection =
        WebConfigurationManager.GetSection("connectionStrings")
        as ConnectionStringsSection;

    // Get the connectionStrings key,value pairs collection.
    ConnectionStringSettingsCollection connectionStrings =
        connectionStringsSection.ConnectionStrings;
   
    // Get the collection enumerator.
    IEnumerator connectionStringsEnum =
        connectionStrings.GetEnumerator();

    // Loop through the collection and 
    // display the connectionStrings key, value pairs.
    int i = 0;
    Console.WriteLine("[Display the connectionStrings]");
    while (connectionStringsEnum.MoveNext())
    {
        string name = connectionStrings[i].Name;
        Console.WriteLine("Name: {0} Value: {1}",
        name, connectionStrings[name]);
        i += 1;
    }

    Console.WriteLine();
}


System.Object
  System.Web.Configuration.WebConfigurationManager

Los miembros estáticos públicos (Shared en Visual Basic) de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Windows 98, Windows 2000 Service Pack 4, Windows CE, Windows Millennium, Windows Mobile para Pocket PC, Windows Mobile para Smartphone, Windows Server 2003, Windows XP Media Center, Windows XP Professional x64, Windows XP SP2, Windows XP Starter

Microsoft .NET Framework 3.0 es compatible con Windows Vista, Microsoft Windows XP SP2 y Windows Server 2003 SP1.

.NET Framework

Compatible con: 3.0, 2.0
Mostrar: