.NET Framework Class Library
ConfigurationManager..::.ConnectionStrings Property

Gets the ConnectionStringsSection data for the current application's default configuration.

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
Syntax

Visual Basic (Declaration)
Public Shared ReadOnly Property ConnectionStrings As ConnectionStringSettingsCollection
Visual Basic (Usage)
Dim value As ConnectionStringSettingsCollection

value = ConfigurationManager.ConnectionStrings
C#
public static ConnectionStringSettingsCollection ConnectionStrings { get; }
Visual C++
public:
static property ConnectionStringSettingsCollection^ ConnectionStrings {
    ConnectionStringSettingsCollection^ get ();
}
JScript
public static function get ConnectionStrings () : ConnectionStringSettingsCollection

Property Value

Type: System.Configuration..::.ConnectionStringSettingsCollection
Returns a ConnectionStringSettingsCollection object that contains the contents of the ConnectionStringsSection object for the current application's default configuration.
Exceptions

ExceptionCondition
ConfigurationErrorsException

Could not retrieve a ConnectionStringSettingsCollection object.

Remarks

A ConnectionStringsSection object contains the contents of the configuration file's connectionStrings section.

Examples

The following code example shows how to use the ConnectionStrings property.

Visual Basic
' Get the ConnectionStrings section.        
' This function uses the ConnectionStrings 
' property to read the connectionStrings
' configuration section.
Public Shared Sub ReadConnectionStrings()

    ' Get the ConnectionStrings collection.
    Dim connections _
        As ConnectionStringSettingsCollection = _
            ConfigurationManager.ConnectionStrings

    If connections.Count <> 0 Then
        Console.WriteLine()
        Console.WriteLine( _
            "Using ConnectionStrings property.")
        Console.WriteLine( _
            "Connection strings:")

        ' Get the collection elements.
        For Each connection _
            As ConnectionStringSettings In connections
            Dim name As String = connection.Name
            Dim provider As String = _
                connection.ProviderName
            Dim connectionString As String = _
                connection.ConnectionString

            Console.WriteLine( _
                "Name:               {0}", name)
            Console.WriteLine( _
                "Connection string:  {0}", _
                    connectionString)
            Console.WriteLine( _
                "Provider:            {0}", provider)
        Next
    Else
        Console.WriteLine()
        Console.WriteLine( _
            "No connection string is defined.")
        Console.WriteLine()
    End If
End Sub
C#
// Get the ConnectionStrings section.        
// This function uses the ConnectionStrings 
// property to read the connectionStrings
// configuration section.
public static void ReadConnectionStrings()
{

  // Get the ConnectionStrings collection.
  ConnectionStringSettingsCollection connections =
      ConfigurationManager.ConnectionStrings;

  if (connections.Count != 0)
  {
    Console.WriteLine();
    Console.WriteLine("Using ConnectionStrings property.");
    Console.WriteLine("Connection strings:");

    // Get the collection elements.
    foreach (ConnectionStringSettings connection in 
      connections)
    {
      string name = connection.Name;
      string provider = connection.ProviderName;
      string connectionString = connection.ConnectionString;

      Console.WriteLine("Name:               {0}", 
        name);
      Console.WriteLine("Connection string:  {0}", 
        connectionString);
     Console.WriteLine("Provider:            {0}", 
        provider);
    }
  }
  else
  {
    Console.WriteLine();
    Console.WriteLine("No connection string is defined.");
    Console.WriteLine();
  }
}
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Other Resources

Tags :


Page view tracker