System.Configuration


.NET Framework Class Library
ConnectionStringSettings Class

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

Represents a single, named connection string in the connection strings configuration file section.

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

Syntax

Visual Basic (Declaration)
Public NotInheritable Class ConnectionStringSettings
    Inherits ConfigurationElement
Visual Basic (Usage)
Dim instance As ConnectionStringSettings
C#
public sealed class ConnectionStringSettings : ConfigurationElement
C++
public ref class ConnectionStringSettings sealed : public ConfigurationElement
J#
public final class ConnectionStringSettings extends ConfigurationElement
JScript
public final class ConnectionStringSettings extends ConfigurationElement
Remarks

A ConnectionStringSettings object represents a single entry in the connectionStrings configuration file section.

TopicLocation
How to: Access SQL Server Using Predetermined CredentialsBuilding ASP .NET Web Applications
How to: Access SQL Server Using Predetermined CredentialsBuilding ASP .NET Web Applications
How to: Access SQL Server Using Predetermined CredentialsBuilding ASP .NET Web Applications in Visual Studio
How to: Access SQL Server Using Predetermined CredentialsBuilding ASP .NET Web Applications in Visual Studio
How to: Read Connection Strings from the Web.config FileConfiguring ASP .NET Web Applications
How to: Read Connection Strings from the Web.config FileConfiguring ASP .NET Web Applications
How to: Read Connection Strings from the Web.config FileBuilding ASP .NET Web Applications in Visual Studio
How to: Read Connection Strings from the Web.config FileBuilding ASP .NET Web Applications in Visual Studio
How to: Secure Connection Strings When Using Data Source ControlsBuilding ASP .NET Web Applications
How to: Secure Connection Strings When Using Data Source ControlsBuilding ASP .NET Web Applications
How To: Secure Connection Strings when Using Data Source ControlsBuilding ASP .NET Web Applications in Visual Studio
How To: Secure Connection Strings when Using Data Source ControlsBuilding ASP .NET Web Applications in Visual Studio
How To: Secure Connection Strings when Using Data Source Controls (Visual Studio)Building ASP .NET Web Applications in Visual Studio
Example

The following example shows how to access a ConnectionStringSettings object at a given index in a ConnectionStringSettingsCollection collection.

Visual Basic
Shared Sub ShowConnectionStrings() 

    ' Get the application configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)

    ' Get the conectionStrings section.
    Dim csSection _
    As ConnectionStringsSection = _
    config.ConnectionStrings
    
    Dim i As Integer
    For i = 0 To ConfigurationManager.ConnectionStrings.Count
        Dim cs As ConnectionStringSettings = _
        csSection.ConnectionStrings(i)
        
        Console.WriteLine( _
        "  Connection String: ""{0""", cs.ConnectionString)
        Console.WriteLine("#{0", i)
        Console.WriteLine("  Name: {0", cs.Name)
        
        Console.WriteLine( _
        "  Provider Name: {0", cs.ProviderName)

    Next i

End Sub 'ShowConnectionStrings
C#
static void ShowConnectionStrings()
{
     // Get the application configuration file.
    System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);

    // Get the conectionStrings section.
    ConnectionStringsSection csSection =
        config.ConnectionStrings;
    
    for (int i = 0; i < 
        ConfigurationManager.ConnectionStrings.Count; i++)
    {
        ConnectionStringSettings cs = 
            csSection.ConnectionStrings[i];
        
        Console.WriteLine("  Connection String: \"{0\"",
            cs.ConnectionString);

        Console.WriteLine("#{0", i);
        Console.WriteLine("  Name: {0", cs.Name);
     
        
        Console.WriteLine("  Provider Name: {0", 
            cs.ProviderName);
        
    

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>
Inheritance Hierarchy

System.Object
   System.Configuration.ConfigurationElement
    System.Configuration.ConnectionStringSettings
Thread Safety

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

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.

Version Information

.NET Framework

Supported in: 2.0
See Also

Tags :


Page view tracker