WebConfigurationManager Класс

Ссылка

Определение

Пространство имен:: System.Web.Configuration

Сборка:: System.Web.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предоставляет доступ к файлам конфигурации при применении к веб-приложениям.

public ref class WebConfigurationManager abstract sealed

public static class WebConfigurationManager

type WebConfigurationManager = class

Public Class WebConfigurationManager

Наследование: Object
WebConfigurationManager

Примеры

В следующем примере показано, как получить доступ к сведениям о конфигурации с помощью

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

Использование WebConfigurationManager — это предпочтительный способ работы с файлами конфигурации, связанными с веб-приложениями. Для клиентских приложений используйте ConfigurationManager класс.

Приложение может расширить System.Configuration типы или использовать их непосредственно для обработки сведений о конфигурации, как описано в следующем списке:

Handling configuration. Для обработки сведений о конфигурации с помощью стандартных типов используется один из следующих подходов:
- Accessing a section. Чтобы получить доступ к сведениям о конфигурации приложения, необходимо использовать один из методов, предоставляемых GetSection WebConfigurationManager. Для <appSettings> и <connectionStrings>, вы используете AppSettings свойства и ConnectionStrings свойства. Эти методы выполняют операции только для чтения, используют один кэшированный экземпляр конфигурации и знают о многопоточном режиме.
- Accessing configuration files. Приложение может считывать и записывать параметры конфигурации на любом уровне, для себя или для других приложений или компьютеров, локально или удаленно. Вы используете один из методов, предоставляемых open WebConfigurationManager. Эти методы возвращают Configuration объект, который, в свою очередь, предоставляет необходимые методы и свойства для обработки базовых файлов конфигурации. Эти методы выполняют операции чтения или записи и повторно создают данные конфигурации при каждом открытии файла.
- Advanced configuration. Более расширенная обработка конфигурации обеспечивается типамиSectionInformation, PropertyInformation, , PropertyInformationCollection, ElementInformation, ContextInformationи ConfigurationSectionGroup ConfigurationSectionGroupCollection.
Extending configuration standard types. Вы также можете предоставить пользовательские элементы конфигурации, расширив стандартные типы конфигурации, такие как ConfigurationElement, ConfigurationElementCollectionи ConfigurationProperty ConfigurationSection с помощью программной или приписываемой модели. Пример ConfigurationSection расширения стандартного типа конфигурации программным способом см. в классе. ConfigurationElement Пример расширения стандартного типа конфигурации с помощью модели с атрибутами см. в классе.

Примечания для тех, кто наследует этот метод

Класс Configuration разрешает программный доступ для редактирования файлов конфигурации. Вы используете один из открытых методов, предоставляемых WebConfigurationManager. Эти методы возвращают Configuration объект, который, в свою очередь, предоставляет необходимые методы и свойства для обработки базовых файлов конфигурации. Вы можете получить доступ к этим файлам для чтения или записи следующим образом: Используется GetSection(String) или GetSectionGroup(String) для чтения сведений о конфигурации. Обратите внимание, что пользователь или процесс чтения должны иметь следующие разрешения: — разрешение на чтение файла конфигурации на текущем уровне иерархии конфигурации.

— чтение разрешений для всех родительских файлов конфигурации.

Если приложению требуется доступ только для чтения к собственной конфигурации, рекомендуется использовать GetSection методы. Эти методы предоставляют доступ к кэшируемым значениям конфигурации для текущего приложения, что обеспечивает лучшую производительность, чем Configuration класс.

Примечание. Если используется статический GetSection метод, принимающий path параметр, параметр пути должен ссылаться на приложение, в котором выполняется код; в противном случае параметр игнорируется и возвращается информация о конфигурации текущего приложения.

Для записи сведений Save о конфигурации используется один из методов. Обратите внимание, что у пользователя или процесса, записываемого в систему, должны быть следующие разрешения: — разрешение на запись файла конфигурации и каталога на текущем уровне иерархии конфигурации.

— разрешение на чтение всех файлов конфигурации.

Свойства

AppSettings	Получает параметры веб-приложения.
ConnectionStrings	Получает строки подключения веб-сайта.

Методы

GetSection(String)	Извлекает указанный раздел конфигурации из текущего файла конфигурации веб-приложения.
GetSection(String, String)	Извлекает указанный раздел конфигурации из файла конфигурации веб-приложения в заданном расположении.
GetWebApplicationSection(String)	Извлекает указанный раздел конфигурации из текущего файла конфигурации веб-приложения.
OpenMachineConfiguration()	Открывает файл конфигурации компьютера на текущем компьютере в качестве объекта Configuration для выполнения операций чтения или записи.
OpenMachineConfiguration(String)	Открывает файл конфигурации компьютера на текущем компьютере в качестве объекта Configuration для выполнения операций чтения или записи.
OpenMachineConfiguration(String, String)	Открывает указанный файл конфигурации компьютера на указанном сервере в качестве объекта Configuration для выполнения операций чтения или записи.
OpenMachineConfiguration(String, String, IntPtr)	Открывает указанный файл конфигурации компьютера на указанном сервере в качестве объекта Configuration с помощью указанного контекста безопасности для выполнения операций чтения или записи.
OpenMachineConfiguration(String, String, String, String)	Открывает указанный файл конфигурации компьютера на указанном сервере в качестве объекта Configuration с помощью указанного контекста безопасности для выполнения операций чтения или записи.
OpenMappedMachineConfiguration(ConfigurationFileMap)	Открывает файл конфигурации компьютера в качестве объекта Configuration с помощью указанного сопоставления файла для выполнения операций чтения или записи.
OpenMappedMachineConfiguration(ConfigurationFileMap, String)	Открывает файл конфигурации компьютера в качестве объекта Configuration с помощью указанного сопоставления и размещения файла для выполнения операций чтения или записи.
OpenMappedWebConfiguration(WebConfigurationFileMap, String)	Открывает указанный файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного сопоставления файла для выполнения операций чтения или записи.
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String)	Открывает указанный файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного сопоставления файла, виртуального пути и имени сайта для выполнения операций чтения или записи.
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String, String)	Открывает указанный файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного сопоставления файла, виртуального пути, имени сайта и расположения для выполнения операций чтения или записи.
OpenWebConfiguration(String)	Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути для выполнения операций чтения или записи.
OpenWebConfiguration(String, String)	Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути и имени сайта для выполнения операций чтения или записи.
OpenWebConfiguration(String, String, String)	Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта и расположения для выполнения операций чтения или записи.
OpenWebConfiguration(String, String, String, String)	Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта, расположения и сервера для выполнения операций чтения или записи.
OpenWebConfiguration(String, String, String, String, IntPtr)	Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта, расположения, сервера и контекста безопасности для выполнения операций чтения или записи.
OpenWebConfiguration(String, String, String, String, String, String)	Открывает файл конфигурации веб-приложения в качестве объекта Configuration с помощью указанного виртуального пути, имени сайта, расположения, сервера и контекста безопасности для выполнения операций чтения или записи.

Применяется к