ConnectionStringsSection Class

Note: This class is new in the .NET Framework version 2.0.

Provides programmatic access to the connection strings configuration-file section.

Namespace: System.Configuration
Assembly: System.Configuration (in system.configuration.dll)

'Declaration
Public NotInheritable Class ConnectionStringsSection
	Inherits ConfigurationSection
'Usage
Dim instance As ConnectionStringsSection

public final class ConnectionStringsSection extends ConfigurationSection
public final class ConnectionStringsSection extends ConfigurationSection

The ConnectionStringsSection class allows you to programmatically modify the connectionStrings section of the configuration file. The connection strings are provided as a ConnectionStringSettingsCollection of ConnectionStringSettingsadd configuration elements.

The following example shows how to use the ConnectionStringsSection.

' Create a connectionn string element and add it to
' the connection strings section.
Shared Sub New() 

    ' Get the application configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)
    
    ' Get the current connection strings count.
    Dim connStrCnt As Integer = _
    ConfigurationManager.ConnectionStrings.Count
    
    ' Create the connection string name. 
    Dim csName As String = "ConnStr" + connStrCnt.ToString()
    
    ' Create a connection string element and
    ' save it to the configuration file.
    ' Create a connection string element.
    Dim csSettings _
    As New ConnectionStringSettings( _
    csName, _
    "LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;" + _
    "Initial Catalog=aspnetdb", "System.Data.SqlClient")
    
    ' Get the connection strings section.
    Dim csSection _
    As ConnectionStringsSection = _
    config.ConnectionStrings
    
    ' Add the new element.
    csSection.ConnectionStrings.Add(csSettings)
    
    ' Save the configuration file.
    config.Save(ConfigurationSaveMode.Modified)

End Sub 'New
 

The following excerpt shows the configuration used by the previous example.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <connectionStrings>
    <add name="ConnStr1" connectionString="LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;Initial Catalog=aspnetdb"
      providerName="System.Data.SqlClient" />
  </connectionStrings>
</configuration>

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: