WebConfigurationManager Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет доступ к файлам конфигурации при применении к веб-приложениям.
public ref class WebConfigurationManager abstract sealed
public static class WebConfigurationManager
type WebConfigurationManager = class
Public Class WebConfigurationManager
- Наследование
-
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 позволяет получить доступ к сведениям о компьютере и приложении.
Использование 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, ContextInformationConfigurationSectionGroupи ConfigurationSectionGroupCollection.
Extending configuration standard types. Вы также можете предоставить пользовательские элементы конфигурации, расширив стандартные типы конфигурации, такие как ConfigurationElement, ConfigurationElementCollectionConfigurationPropertyи ConfigurationSection с помощью программной или атрибутной модели. Ознакомьтесь с ConfigurationSection классом, например, как расширить стандартный тип конфигурации программным способом. Пример расширения стандартного типа конфигурации с помощью модели атрибута см. в ConfigurationElement классе.
Примечания для тех, кто наследует этот метод
Класс предоставляет программный Configuration доступ для редактирования файлов конфигурации. Вы используете один из открытых методов, WebConfigurationManagerпредоставляемых . Эти методы возвращают Configuration объект, который, в свою очередь, предоставляет необходимые методы и свойства для обработки базовых файлов конфигурации. Эти файлы можно получить для чтения или записи следующим образом:
Вы используете GetSection(String) или GetSectionGroup(String) считываете сведения о конфигурации. Обратите внимание, что пользователь или процесс, который считывает, должен иметь следующие разрешения:
Разрешение на чтение файла конфигурации на текущем уровне иерархии конфигурации.
Разрешения на чтение всех родительских файлов конфигурации.
Если приложению требуется доступ только для чтения к собственной конфигурации, рекомендуется использовать GetSection методы. Эти методы предоставляют доступ к кэшируемым значениям конфигурации для текущего приложения, который имеет лучшую производительность, чем Configuration класс.
Примечание. Если используется статический GetSection метод, path принимаюющий параметр, параметр пути должен ссылаться на приложение, в котором выполняется код. В противном случае параметр игнорируется и возвращается информация о конфигурации для текущего приложения.
Для записи сведений Save о конфигурации используется один из методов. Обратите внимание, что пользователь или процесс записи должен иметь следующие разрешения:
Разрешение на запись файла конфигурации и каталога на текущем уровне иерархии конфигурации.
Разрешения на чтение всех файлов конфигурации.
Свойства
| Имя | Описание |
|---|---|
| AppSettings |
Возвращает параметры приложения веб-сайта. |
| ConnectionStrings |
Возвращает строки подключения веб-сайта. |
Методы
| Имя | Описание |
|---|---|
| GetSection(String, String) |
Извлекает указанный раздел конфигурации из файла конфигурации веб-приложения в указанном расположении. |
| GetSection(String) |
Извлекает указанный раздел конфигурации из файла конфигурации текущего веб-приложения. |
| GetWebApplicationSection(String) |
Извлекает указанный раздел конфигурации из файла конфигурации текущего веб-приложения. |
| OpenMachineConfiguration() |
Открывает файл конфигурации компьютера на текущем компьютере в качестве Configuration объекта, чтобы разрешить операции чтения или записи. |
| OpenMachineConfiguration(String, String, IntPtr) |
Открывает указанный файл конфигурации компьютера на указанном сервере в качестве Configuration объекта, используя указанный контекст безопасности для разрешения операций чтения или записи. |
| OpenMachineConfiguration(String, String, String, String) |
Открывает указанный файл конфигурации компьютера на указанном сервере в качестве Configuration объекта, используя указанный контекст безопасности для разрешения операций чтения или записи. |
| OpenMachineConfiguration(String, String) |
Открывает указанный файл конфигурации компьютера на указанном сервере в качестве Configuration объекта, чтобы разрешить операции чтения или записи. |
| OpenMachineConfiguration(String) |
Открывает файл конфигурации компьютера на текущем компьютере в качестве Configuration объекта, чтобы разрешить операции чтения или записи. |
| OpenMappedMachineConfiguration(ConfigurationFileMap, String) |
Открывает файл конфигурации компьютера в качестве Configuration объекта, используя указанное сопоставление файлов и расположение, чтобы разрешить операции чтения или записи. |
| OpenMappedMachineConfiguration(ConfigurationFileMap) |
Открывает файл конфигурации компьютера в качестве Configuration объекта, используя указанное сопоставление файлов, чтобы разрешить операции чтения или записи. |
| OpenMappedWebConfiguration(WebConfigurationFileMap, String, String, String) |
Открывает указанный файл конфигурации веб-приложения в качестве Configuration объекта, используя указанное сопоставление файлов, виртуальный путь, имя сайта и расположение для разрешения операций чтения или записи. |
| OpenMappedWebConfiguration(WebConfigurationFileMap, String, String) |
Открывает указанный Configuration файл конфигурации веб-приложения в качестве объекта, используя указанное сопоставление файлов, виртуальный путь и имя сайта, чтобы разрешить операции чтения или записи. |
| OpenMappedWebConfiguration(WebConfigurationFileMap, String) |
Открывает указанный Configuration файл конфигурации веб-приложения в качестве объекта, используя указанное сопоставление файлов и виртуальный путь для разрешения операций чтения или записи. |
| OpenWebConfiguration(String, String, String, String, IntPtr) |
Открывает файл конфигурации веб-приложения в качестве Configuration объекта с помощью указанного виртуального пути, имени сайта, расположения, сервера и контекста безопасности для разрешения операций чтения или записи. |
| OpenWebConfiguration(String, String, String, String, String, String) |
Открывает файл конфигурации веб-приложения в качестве Configuration объекта с помощью указанного виртуального пути, имени сайта, расположения, сервера и контекста безопасности для разрешения операций чтения или записи. |
| OpenWebConfiguration(String, String, String, String) |
Открывает файл конфигурации веб-приложения в качестве объекта, используя указанный Configuration виртуальный путь, имя сайта, расположение и сервер, чтобы разрешить операции чтения или записи. |
| OpenWebConfiguration(String, String, String) |
Открывает файл конфигурации веб-приложения в качестве объекта, используя указанный виртуальный Configuration путь, имя сайта и расположение, чтобы разрешить операции чтения или записи. |
| OpenWebConfiguration(String, String) |
Открывает файл конфигурации веб-приложения в качестве объекта, используя указанный виртуальный Configuration путь и имя сайта, чтобы разрешить операции чтения или записи. |
| OpenWebConfiguration(String) |
Открывает файл конфигурации веб-приложения в качестве объекта, используя указанный виртуальный Configuration путь для разрешения операций чтения или записи. |