WebConfigurationManager Class

Definition

Предоставляет доступ к файлам конфигурации при применении к веб-приложениям.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
Inheritance
WebConfigurationManager

Examples

В следующем примере показано, как получить доступ к сведениям о конфигурации с помощьюThe following example shows how to access configuration information with the

Метод 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


Remarks

Класс WebConfigurationManager позволяет получить доступ к сведениям о компьютере и приложении.The WebConfigurationManager class allows you to access computer and application information.

Использование WebConfigurationManager является предпочтительным способом работы с файлами конфигурации, связанными с веб-приложениями.Using WebConfigurationManager is the preferred way to work with configuration files related to Web applications. Для клиентских приложений используйте класс ConfigurationManager.For client applications, use the ConfigurationManager class.

Приложение может расширять типы System.Configuration или использовать их непосредственно для управления сведениями о конфигурации, как описано в следующем списке.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. Для управления сведениями о конфигурации с использованием стандартных типов используется один из следующих подходов:To handle configuration information using the standard types, you use one of the following approaches:

    • Accessing a section.Accessing a section. Чтобы получить доступ к сведениям о конфигурации приложения, необходимо использовать один из GetSection методов, предоставляемых WebConfigurationManager.To access configuration information for your application, you must use one of the GetSection methods provided by WebConfigurationManager. Для <appSettings> и <connectionStrings>используются свойства AppSettings и ConnectionStrings.For <appSettings> and <connectionStrings>, you use the AppSettings and ConnectionStrings properties. Эти методы выполняют операции только для чтения, используют один кэшированный экземпляр конфигурации и поддерживают многопоточность.These methods perform read-only operations, use a single cached instance of the configuration, and are multithread aware.

    • Accessing configuration files.Accessing configuration files. Приложение может считывать и записывать параметры конфигурации на любом уровне, для самого себя или для других приложений или компьютеров локально или удаленно.Your application can read and write configuration settings at any level, for itself or for other applications or computers, locally or remotely. Вы используете один из open методов, предоставляемых WebConfigurationManager.You use one of the open methods provided by WebConfigurationManager. Эти методы возвращают объект Configuration, который, в свою очередь, предоставляет необходимые методы и свойства для управления базовыми файлами конфигурации.These methods will return a Configuration object, which in turn provides the required methods and properties to handle the underlying configuration files. Эти методы выполняют операции чтения или записи и повторно создают данные конфигурации при каждом открытии файла.These methods perform read or write operations and recreate the configuration data every time a file is opened.

    • Advanced configuration.Advanced configuration. Более сложная обработка конфигурации обеспечивается типами SectionInformation, PropertyInformation, PropertyInformationCollection, ElementInformation, ContextInformation, ConfigurationSectionGroupи ConfigurationSectionGroupCollection.More advanced configuration handling is provided by the types SectionInformation, PropertyInformation, PropertyInformationCollection, ElementInformation, ContextInformation, ConfigurationSectionGroup, and ConfigurationSectionGroupCollection.

  • Extending configuration standard types.Extending configuration standard types. Вы также можете предоставить настраиваемые элементы конфигурации, расширяя стандартные типы конфигурации, такие как ConfigurationElement, ConfigurationElementCollection, ConfigurationPropertyи ConfigurationSection, используя программную или атрибутивную модель.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. Пример программного расширения стандартного типа конфигурации см. в ConfigurationSection классе.Refer to the ConfigurationSection class for an example of how to extend a standard configuration type programmatically. Пример расширения стандартного типа конфигурации с использованием модели с атрибутами см. в ConfigurationElement классе.Refer to the ConfigurationElement class for an example of how to extend a standard configuration type using the attributed model.

Notes to Inheritors

Класс Configuration обеспечивает программный доступ для редактирования файлов конфигурации.The Configuration class allows programmatic access for editing configuration files. Вы используете один из открытых методов, предоставляемых WebConfigurationManager.You use one of the open methods provided by WebConfigurationManager. Эти методы возвращают объект Configuration, который, в свою очередь, предоставляет необходимые методы и свойства для управления базовыми файлами конфигурации.These methods will return a Configuration object, which in turn provides the required methods and properties to handle the underlying configuration files. Вы можете получить доступ к этим файлам для чтения или записи следующим образом:You can access these files for reading or writing as follows: Для чтения сведений о конфигурации используется GetSection(String) или GetSectionGroup(String).You use GetSection(String) or GetSectionGroup(String) to read configuration information. Обратите внимание, что чтение пользователя или процесса должно иметь следующие разрешения:Note that the user or process that reads must have the following permissions: — Разрешение на чтение файла конфигурации на текущем уровне иерархии конфигурации.- Read permission on the configuration file at the current configuration hierarchy level.

— Разрешения на чтение всех родительских файлов конфигурации.- Read permissions on all the parent configuration files.

Если приложению требуется доступ только для чтения к своей собственной конфигурации, рекомендуется использовать методы GetSection.If your application needs read-only access to its own configuration, it is recommended you use the GetSection methods. Эти методы предоставляют доступ к кэшированным значениям конфигурации для текущего приложения, что обеспечивает лучшую производительность по сравнению с классом Configuration.These methods provide access to the cached configuration values for the current application, which has better performance than the Configuration class.


Если используется статический метод GetSection, принимающий параметр path, параметр path должен ссылаться на приложение, в котором выполняется код. в противном случае параметр игнорируется, и возвращаются сведения о конфигурации для текущего приложения.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.

Для записи сведений о конфигурации используется один из Save методов.You use one of the Save methods to write configuration information. Обратите внимание, что пользователь или процесс, выполняющий запись, должен иметь следующие разрешения:Note that the user or process that writes must have the following permissions: — Разрешение на запись в файл конфигурации и каталог на текущем уровне иерархии конфигурации.- Write permission on the configuration file and directory at the current configuration hierarchy level. — Разрешения на чтение для всех файлов конфигурации.- Read permissions on all the configuration files.

Properties

AppSettings

Получает параметры веб-приложения.Gets the Web site's application settings.

ConnectionStrings

Получает строки подключения веб-сайта.Gets the Web site's connection strings.

Methods

GetSection(String)

Извлекает указанный раздел конфигурации из текущего файла конфигурации веб-приложения.Retrieves the specified configuration section from the current Web application's configuration file.

GetSection(String, String)

Извлекает указанный раздел конфигурации из файла конфигурации веб-приложения в заданном расположении.Retrieves the specified configuration section from the Web application's configuration file at the specified location.

GetWebApplicationSection(String)

Извлекает указанный раздел конфигурации из текущего файла конфигурации веб-приложения.Retrieves the specified configuration section from the current Web application's configuration file.

OpenMachineConfiguration()

Открывает файл конфигурации компьютера на текущем компьютере в качестве объекта Configuration для выполнения операций чтения или записи.Opens the machine-configuration file on the current computer as a Configuration object to allow read or write operations.

OpenMachineConfiguration(String)

Открывает файл конфигурации компьютера на текущем компьютере в качестве объекта Configuration для выполнения операций чтения или записи.Opens the machine-configuration file on the current computer as a Configuration object to allow read or write operations.

OpenMachineConfiguration(String, String)

Открывает указанный файл конфигурации компьютера на указанном сервере в качестве объекта Configuration для выполнения операций чтения или записи.Opens the specified machine-configuration file on the specified server as a Configuration object to allow read or write operations.

OpenMachineConfiguration(String, String, IntPtr)

Открывает указанный файл конфигурации компьютера на указанном сервере в качестве объекта Configuration с помощью указанного контекста безопасности для выполнения операций чтения или записи.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)

Открывает указанный файл конфигурации компьютера на указанном сервере в качестве объекта Configuration с помощью указанного контекста безопасности для выполнения операций чтения или записи.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)

Открывает файл конфигурации компьютера в качестве объекта Configuration с помощью указанного сопоставления файла для выполнения операций чтения или записи.Opens the machine-configuration file as a Configuration object, using the specified file mapping to allow read or write operations.

OpenMappedMachineConfiguration(ConfigurationFileMap, String)

Открывает файл конфигурации компьютера в качестве объекта Configuration с помощью указанного сопоставления и размещения файла для выполнения операций чтения или записи.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)

Открывает указанный файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного сопоставления файла для выполнения операций чтения или записи.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)

Открывает указанный файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного сопоставления файла, виртуального пути и имени сайта для выполнения операций чтения или записи.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)

Открывает указанный файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного сопоставления файла, виртуального пути, имени сайта и расположения для выполнения операций чтения или записи.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)

Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути для выполнения операций чтения или записи.Opens the Web-application configuration file as a Configuration object using the specified virtual path to allow read or write operations.

OpenWebConfiguration(String, String)

Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути и имени сайта для выполнения операций чтения или записи.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)

Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта и расположения для выполнения операций чтения или записи.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)

Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта, расположения и сервера для выполнения операций чтения или записи.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)

Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта, расположения, сервера и контекста безопасности для выполнения операций чтения или записи.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)

Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта, расположения, сервера и контекста безопасности для выполнения операций чтения или записи.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.

Applies to

See also