This documentation is archived and is not being maintained.

ConnectionStringSettings Class

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

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.

Imports System
Imports System.Collections.Generic
Imports System.Configuration
Imports System.Web.Configuration
Imports System.Collections
Imports System.Text


Namespace ConfigurationStringSettings

    Class ConfigurationStringSettings

        Shared Sub DisplayConnectionStrings()
            ' Set the path of the config file. 
            ' Make sure that you have a Web site on the 
            ' same server called TestConfig.  
            Dim configPath As String = "/TestConfig" 

            ' Get the Web application configuration object. 
            Dim config As Configuration = _
            WebConfigurationManager.OpenWebConfiguration(configPath)


            ' Get the conectionStrings section. 
            Dim csSection As ConnectionStringsSection = _
            config.ConnectionStrings

            Console.WriteLine("Display configuration strings.")

            Dim i As Integer = 0
            While i < 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)
                System.Math.Max(System.Threading.Interlocked.Increment(i), i - 1)
            End While 

        End Sub 


        Shared Sub Main(ByVal args As String())
            Try 
                ' Display connection strings.
                DisplayConnectionStrings()
            Catch e As Exception
                ' Unknown error.
                Console.WriteLine(e.ToString())
            End Try 

            ' Display and wait.
            Console.WriteLine("Enter any key to exit.")
            Console.ReadLine()
        End Sub 
    End Class 
End Namespace

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 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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: