WebConfigurationManager Clase

Definición

Proporciona acceso a los archivos de configuración cuando se aplican a las aplicaciones Web.Provides access to configuration files as they apply to Web applications.

public ref class WebConfigurationManager abstract sealed
public static class WebConfigurationManager
type WebConfigurationManager = class
Public Class WebConfigurationManager
Herencia
WebConfigurationManager

Ejemplos

En el ejemplo siguiente se muestra cómo obtener acceso a la información de configuración con elThe following example shows how to access configuration information with the

Método GetSection.GetSection method.


// 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 clase WebConfigurationManager permite tener acceso a la información del equipo y de la aplicación.The WebConfigurationManager class allows you to access computer and application information.

El uso de WebConfigurationManager es la manera preferida de trabajar con archivos de configuración relacionados con las aplicaciones Web.Using WebConfigurationManager is the preferred way to work with configuration files related to Web applications. En el caso de las aplicaciones cliente, use la clase ConfigurationManager.For client applications, use the ConfigurationManager class.

La aplicación puede extender los tipos de System.Configuration o usarlos directamente para controlar la información de configuración, como se explica en la siguiente lista:Your application can extend the System.Configuration types or use them directly to handle configuration information, as explained in the following list:

  • Handling configuration.Handling configuration. Para controlar la información de configuración mediante los tipos estándar, se usa uno de los métodos siguientes:To handle configuration information using the standard types, you use one of the following approaches:

  • Extending configuration standard types.Extending configuration standard types. También puede proporcionar los elementos de configuración personalizados extendiendo los tipos de configuración estándar, como ConfigurationElement, ConfigurationElementCollection, ConfigurationPropertyy ConfigurationSection mediante un modelo con atributos o mediante programación.You can also provide your custom configuration elements by extending the standard configuration types such as ConfigurationElement, ConfigurationElementCollection, ConfigurationProperty, and ConfigurationSection by using a programmatic or an attributed model. Consulte la clase ConfigurationSection para obtener un ejemplo de cómo extender un tipo de configuración estándar mediante programación.Refer to the ConfigurationSection class for an example of how to extend a standard configuration type programmatically. Consulte la clase ConfigurationElement para obtener un ejemplo de cómo extender un tipo de configuración estándar mediante el modelo con atributos.Refer to the ConfigurationElement class for an example of how to extend a standard configuration type using the attributed model.

Notas a los desarrolladores de herederos

La clase Configuration permite el acceso mediante programación para editar archivos de configuración.The Configuration class allows programmatic access for editing configuration files. Puede usar uno de los métodos abiertos proporcionados por WebConfigurationManager.You use one of the open methods provided by WebConfigurationManager. Estos métodos devolverán un objeto Configuration, que a su vez proporciona los métodos y las propiedades necesarios para controlar los archivos de configuración subyacentes.These methods will return a Configuration object, which in turn provides the required methods and properties to handle the underlying configuration files. Puede tener acceso a estos archivos para lectura o escritura como se indica a continuación:You can access these files for reading or writing as follows: Utilice GetSection(String) o GetSectionGroup(String) para leer la información de configuración.You use GetSection(String) or GetSectionGroup(String) to read configuration information. Tenga en cuenta que el usuario o proceso que lee debe tener los permisos siguientes:Note that the user or process that reads must have the following permissions: -Permiso de lectura en el archivo de configuración en el nivel de la jerarquía de configuración actual.- Read permission on the configuration file at the current configuration hierarchy level.

: Permisos de lectura en todos los archivos de configuración principales.- Read permissions on all the parent configuration files.

Si la aplicación necesita acceso de solo lectura a su propia configuración, se recomienda usar los métodos de GetSection.If your application needs read-only access to its own configuration, it is recommended you use the GetSection methods. 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 el Configuration clase.These methods provide access to the cached configuration values for the current application, which has better performance than the Configuration class.


Si usa un método GetSection estático que toma un parámetro path, el parámetro Path debe hacer referencia a la aplicación en la que se está ejecutando 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.If you use a static GetSection method that takes a path parameter, the path parameter must refer to the application in which the code is running; otherwise, the parameter is ignored and configuration information for the currently-running application is returned.

Puede usar uno de los métodos Save para escribir información de configuración.You use one of the Save methods to write configuration information. Tenga en cuenta que el usuario o proceso que escribe debe tener los permisos siguientes:Note that the user or process that writes must have the following permissions: -Permiso de escritura en el archivo de configuración y el directorio en el nivel de la jerarquía de configuración actual.- Write permission on the configuration file and directory at the current configuration hierarchy level. : Permisos de lectura en todos los archivos de configuración.- Read permissions on all the configuration files.

Propiedades

AppSettings

Obtiene las configuraciones de la aplicación del sitio web.Gets the Web site's application settings.

ConnectionStrings

Obtiene las cadenas de conexión del sitio web.Gets the Web site's connection strings.

Métodos

GetSection(String)

Recupera la sección de configuración especificada del archivo de configuración de la aplicación Web actual.Retrieves the specified configuration section from the current Web application's configuration file.

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.Retrieves the specified configuration section from the Web application's configuration file at the specified location.

GetWebApplicationSection(String)

Recupera la sección de configuración especificada del archivo de configuración de la aplicación Web actual.Retrieves the specified configuration section from the current Web application's configuration file.

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.Opens the machine-configuration file on the current computer as a Configuration object to allow read or write operations.

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.Opens the machine-configuration file on the current computer as a Configuration object to allow read or write operations.

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.Opens the specified machine-configuration file on the specified server as a Configuration object to allow read or write operations.

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.Opens the specified machine-configuration file on the specified server as a Configuration object, using the specified security context to allow read or write operations.

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.Opens the specified machine-configuration file on the specified server as a Configuration object, using the specified security context to allow read or write operations.

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.Opens the machine-configuration file as a Configuration object, using the specified file mapping to allow read or write operations.

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.Opens the machine-configuration file as a Configuration object using the specified file mapping and location to allow read or write operations.

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.Opens the specified Web-application configuration file as a Configuration object using the specified file mapping and virtual path to allow read or write operations.

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.Opens the specified Web application configuration file as a Configuration object using the specified file mapping, virtual path, and site name to allow read or write operations.

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.Opens the specified Web-application configuration file as a Configuration object using the specified file mapping, virtual path, site name, and location to allow read or write operations.

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.Opens the Web-application configuration file as a Configuration object using the specified virtual path to allow read or write operations.

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.Opens the Web-application configuration file as a Configuration object using the specified virtual path and site name to allow read or write operations.

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.Opens the Web-application configuration file as a Configuration object using the specified virtual path, site name, and location to allow read or write operations.

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.Opens the Web-application configuration file as a Configuration object using the specified virtual path, site name, location, and server to allow read or write operations.

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.Opens the Web-application configuration file as a Configuration object using the specified virtual path, site name, location, server, and security context to allow read or write operations.

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.Opens the Web-application configuration file as a Configuration object using the specified virtual path, site name, location, server, and security context to allow read or write operations.

Se aplica a

Consulte también: