Configuration Class
Assembly: System.Configuration (in system.configuration.dll)
The Configuration class instance represents the merged view of the configuration settings that apply to a specific physical entity, such as a computer, or to a logical entity, such as an application, or a Web site. The specified logical entity can exist on the local computer or on a remote server.
When no configuration file exists for a specified entity, the Configuration object represents the default configuration settings as defined by the Machine.config file.
You can get a Configuration object using one of the open configuration methods as defined by the following classes:
To generate a configuration file representing the inherited configuration settings for a specified entity, use one of the save-configuration methods:
Note |
|---|
| To enable access to configuration settings on a remote computer, use the Aspnet_regiis command-line tool. For more information about this tool, see ASP.NET IIS Registration Tool (Aspnet_regiis.exe). For information about creating and accessing custom configuration settings other than the intrinsic sections included in the .NET Framework, refer to ConfigurationSection. |
-
Reading. You use GetSection or GetSectionGroup to read configuration information. Note 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.
-
Note |
|---|
| 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. |
-
Writing. You use one of the Save methods to write configuration information. Note 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.
-
| Topic | Location |
|---|---|
| How to: Connect to an Oracle Database Using the SqlDataSource Control | Building ASP .NET Web Applications |
| How to: Connect to an Oracle Database Using the SqlDataSource Control | Building ASP .NET Web Applications |
The following code example demonstrates how to use the Configuration class to create a configuration file containing a custom section.
' Create a custom section. Shared Sub CreateSection() Try Dim customSection As CustomSection ' Get the current configuration file. Dim config As _ System.Configuration.Configuration = _ ConfigurationManager.OpenExeConfiguration( _ ConfigurationUserLevel.None) ' Create the section entry ' in <configSections> and the ' related target section in <configuration>. If config.Sections("CustomSection") Is Nothing Then customSection = New CustomSection() config.Sections.Add("CustomSection", customSection) customSection.SectionInformation.ForceSave = True config.Save(ConfigurationSaveMode.Full) Console.WriteLine( _ "Section name: {0 created", _ customSection.SectionInformation.Name) End If Catch err As ConfigurationErrorsException Console.WriteLine(err.ToString()) End Try End Sub 'CreateSection
The following is the definition of the custom section as used by the previous example.
' Define a custom section. NotInheritable Public Class CustomSection Inherits ConfigurationSection Public Enum Permissions FullControl = 0 Modify = 1 ReadExecute = 2 Read = 3 Write = 4 SpecialPermissions = 5 End Enum 'Permissions Public Sub New() End Sub 'New <ConfigurationProperty("fileName", _ DefaultValue:="default.txt"), _ StringValidator(InvalidCharacters:=" ~!@#$%^&*()[]{/;'""|\", _ MinLength:=1, MaxLength:=60)> _ Public Property FileName() As String Get Return CStr(Me("fileName")) End Get Set(ByVal value As String) Me("fileName") = Value End Set End Property <ConfigurationProperty("maxIdleTime", _ DefaultValue:="1:30:30")> _ Public Property MaxIdleTime() As TimeSpan Get Return CType(Me("maxIdleTime"), TimeSpan) End Get Set(ByVal value As TimeSpan) Me("maxIdleTime") = Value End Set End Property <ConfigurationProperty("permission", _ DefaultValue:=Permissions.Read)> _ Public Property Permission() As Permissions Get Return CType(Me("permission"), Permissions) End Get Set(ByVal value As Permissions) Me("permission") = Value End Set End Property End Class 'CustomSection
The following is a configuration excerpt as used by the previous example.
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<configSections>
<section name="CustomSection" type="Samples.AspNet.CustomSection,
Configuration, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=null" allowDefinition="Everywhere"
allowExeDefinition="MachineToApplication"
restartOnExternalChanges="true" />
</configSections>
<CustomSection fileName="default.txt" maxIdleTime="01:30:30"
permission="Read" />
</configuration>
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Note