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)

'Declaration
Public NotInheritable Class ConnectionStringSettings
	Inherits ConfigurationElement
'Usage
Dim instance As ConnectionStringSettings

public final class ConnectionStringSettings extends ConfigurationElement
public final class ConnectionStringSettings extends ConfigurationElement

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

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

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


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>

System.Object
   System.Configuration.ConfigurationElement
    System.Configuration.ConnectionStringSettings

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: