WebConfigurationManager Clase

Referencia

Definición

Espacio de nombres:: System.Web.Configuration

Ensamblado:: System.Web.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

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

public ref class WebConfigurationManager abstract sealed

public static class WebConfigurationManager

type WebConfigurationManager = class

Public Class WebConfigurationManager

Herencia: Object
WebConfigurationManager

Ejemplos

En el ejemplo siguiente se muestra cómo acceder a la información de configuración con

Método GetSection.


// Show how to use the GetSection(string). 
// to access the connectionStrings section.
static void GetConnectionStringsSection()
{

    // 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();
}

' Show how to use the GetSection(string). 
' to access the connectionStrings section.
Shared Sub GetConnectionStringsSection()
   
   ' Get the connectionStrings section.
     Dim connectionStringsSection As ConnectionStringsSection = _
     WebConfigurationManager.GetSection("connectionStrings")
   
   ' Get the connectionStrings key,value pairs collection.
     Dim connectionStrings As ConnectionStringSettingsCollection = _
     connectionStringsSection.ConnectionStrings
   
   ' Get the collection enumerator.
     Dim connectionStringsEnum As IEnumerator = _
     connectionStrings.GetEnumerator()
   
   ' Loop through the collection and 
   ' display the connectionStrings key, value pairs.
   Dim i As Integer = 0
   Console.WriteLine("[Display the connectionStrings]")
   While connectionStringsEnum.MoveNext()
      Dim name As String = connectionStrings(i).Name
         Console.WriteLine("Name: {0} Value: {1}", _
         name, connectionStrings(name))
      i += 1
   End While
   
   Console.WriteLine()
End Sub

Comentarios

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

Usar WebConfigurationManager es la manera preferida de trabajar con archivos de configuración relacionados con aplicaciones web. Para las aplicaciones cliente, use la ConfigurationManager clase .

La aplicación puede ampliar los System.Configuration tipos o usarlos directamente para controlar la información de configuración, como se explica en la lista siguiente:

Handling configuration. Para controlar la información de configuración mediante los tipos estándar, use uno de los métodos siguientes:
- Accessing a section. Para acceder a la información de configuración de la aplicación, debe usar uno de los GetSection métodos proporcionados por WebConfigurationManager. Para <appSettings> y <connectionStrings>, se usan las AppSettings propiedades y ConnectionStrings . Estos métodos realizan operaciones de solo lectura, usan una única instancia almacenada en caché de la configuración y son compatibles con varios subprocesos.
- Accessing configuration files. La aplicación puede leer y escribir opciones de configuración en cualquier nivel, para sí misma o para otras aplicaciones o equipos, de forma local o remota. Use uno de los open métodos proporcionados por WebConfigurationManager. Estos métodos devolverán un Configuration objeto, que a su vez proporciona los métodos y propiedades necesarios para controlar los archivos de configuración subyacentes. Estos métodos realizan operaciones de lectura o escritura y vuelven a crear los datos de configuración cada vez que se abre un archivo.
- Advanced configuration. El control de configuración más avanzado se proporciona mediante los tipos SectionInformation, , PropertyInformationCollection ElementInformation PropertyInformation, ContextInformation, , ConfigurationSectionGroupy .ConfigurationSectionGroupCollection
Extending configuration standard types. También puede proporcionar los elementos de configuración personalizados mediante la extensión de los tipos de configuración estándar, como ConfigurationElement, ConfigurationElementCollection, ConfigurationPropertyy ConfigurationSection mediante un modelo con atributos o mediante programación. Consulte la ConfigurationSection clase para obtener un ejemplo de cómo ampliar un tipo de configuración estándar mediante programación. Consulte la ConfigurationElement clase para obtener un ejemplo de cómo ampliar un tipo de configuración estándar mediante el modelo con atributos.

Notas a los desarrolladores de herederos

La Configuration clase permite el acceso mediante programación para editar archivos de configuración. Use uno de los métodos abiertos proporcionados por WebConfigurationManager. Estos métodos devolverán un Configuration objeto, que a su vez proporciona los métodos y propiedades necesarios para controlar los archivos de configuración subyacentes. Puede acceder a estos archivos para leer o escribir de la siguiente manera:

GetSection(String) Use o GetSectionGroup(String) para leer la información de configuración. Tenga en cuenta que el usuario o el proceso que lee deben tener los permisos siguientes:

Permiso de lectura en el archivo de configuración en el nivel de jerarquía de configuración actual.
Permisos de lectura en todos los archivos de configuración primarios.

Si la aplicación necesita acceso de solo lectura a su propia configuración, se recomienda usar los GetSection métodos . Estos métodos proporcionan acceso a los valores de configuración almacenados en caché para la aplicación actual, que tiene un mejor rendimiento que la Configuration clase .

Nota: Si usa un método estático GetSection que toma un path parámetro, el parámetro path debe hacer referencia a la aplicación en la que se ejecuta el código; de lo contrario, se omite el parámetro y se devuelve la información de configuración de la aplicación que se está ejecutando actualmente.

Use uno de los Save métodos para escribir información de configuración. Tenga en cuenta que el usuario o proceso que escribe debe tener los permisos siguientes:

Permiso de escritura en el archivo de configuración y el directorio en el nivel de jerarquía de configuración actual.
Permisos de lectura en todos los archivos de configuración.

Propiedades

AppSettings	Obtiene las configuraciones de la aplicación del sitio web.
ConnectionStrings	Obtiene las cadenas de conexión del sitio web.

Métodos

GetSection(String)	Recupera la sección de configuración especificada del archivo de configuración de la aplicación Web actual.
GetSection(String, String)	Recupera la sección de configuración especificada del archivo de configuración de la aplicación web y ubicación especificadas.
GetWebApplicationSection(String)	Recupera la sección de configuración especificada del archivo de configuración de la aplicación Web actual.
OpenMachineConfiguration()	Abre el archivo de configuración del equipo en el equipo actual como un objeto Configuration para permitir las operaciones de lectura o escritura.
OpenMachineConfiguration(String)	Abre el archivo de configuración del equipo en el equipo actual como un objeto Configuration para permitir las operaciones de lectura o escritura.
OpenMachineConfiguration(String, String)	Abre el archivo de configuración del equipo en el servidor especificado como un objeto Configuration para permitir operaciones de lectura o escritura.
OpenMachineConfiguration(String, String, IntPtr)	Abre el archivo de configuración del equipo especificado en el servidor especificado como un objeto Configuration, utilizando el contexto de seguridad definido para permitir operaciones de lectura o escritura.
OpenMachineConfiguration(String, String, String, String)	Abre el archivo de configuración del equipo especificado en el servidor especificado como un objeto Configuration, utilizando el contexto de seguridad definido para permitir operaciones de lectura o escritura.
OpenMappedMachineConfiguration(ConfigurationFileMap)	Abre el archivo de configuración del equipo como un objeto Configuration, utilizando la asignación de archivos especificada para permitir operaciones de lectura o escritura.
OpenMappedMachineConfiguration(ConfigurationFileMap, String)	Abre el archivo de configuración del equipo como un objeto Configuration, utilizando la asignación de archivos y la ubicación especificadas para permitir operaciones de lectura o escritura.
OpenMappedWebConfiguration(WebConfigurationFileMap, String)	Abre el archivo de configuración de la aplicación Web especificado como un objeto Configuration, utilizando la asignación de archivos y la ruta de acceso virtual especificadas para permitir operaciones de lectura o escritura.
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String)	Abre el archivo de configuración de la aplicación Web especificado como un objeto Configuration, utilizando la asignación de archivos, la ruta de acceso virtual y el nombre de sitio especificados para permitir operaciones de lectura o escritura.
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String, String)	Abre el archivo de configuración de la aplicación Web especificado como un objeto Configuration, utilizando la asignación de archivos, la ruta de acceso virtual, el nombre de sitio y la ubicación especificados para permitir operaciones de lectura o escritura.
OpenWebConfiguration(String)	Abre el archivo de configuración de la aplicación Web como un objeto Configuration utilizando la ruta de acceso virtual especificada para permitir operaciones de lectura o escritura.
OpenWebConfiguration(String, String)	Abre el archivo de configuración de la aplicación Web como un objeto Configuration utilizando la ruta de acceso virtual y el nombre de sitio especificados para permitir operaciones de lectura o escritura.
OpenWebConfiguration(String, String, String)	Abre el archivo de configuración de la aplicación Web como un objeto Configuration utilizando la ruta de acceso virtual, el nombre de sitio y la ubicación especificados para permitir operaciones de lectura o escritura.
OpenWebConfiguration(String, String, String, String)	Abre el archivo de configuración de la aplicación Web como un objeto Configuration utilizando la ruta de acceso virtual, el nombre de sitio, la ubicación y el servidor especificados para permitir operaciones de lectura o escritura.
OpenWebConfiguration(String, String, String, String, IntPtr)	Abre el archivo de configuración de la aplicación Web como un objeto Configuration utilizando la ruta de acceso virtual, el nombre de sitio, la ubicación, el servidor y el contexto de seguridad especificados para permitir operaciones de lectura o escritura.
OpenWebConfiguration(String, String, String, String, String, String)	Abre el archivo de configuración de la aplicación Web como un objeto Configuration utilizando la ruta de acceso virtual, el nombre de sitio, la ubicación, el servidor y el contexto de seguridad especificados para permitir operaciones de lectura o escritura.

Se aplica a

Compartir vía