WebConfigurationManager.ConnectionStrings Property

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the Web site's connection strings.

public:
 static property System::Configuration::ConnectionStringSettingsCollection ^ ConnectionStrings { System::Configuration::ConnectionStringSettingsCollection ^ get(); };

public static System.Configuration.ConnectionStringSettingsCollection ConnectionStrings { get; }

static member ConnectionStrings : System.Configuration.ConnectionStringSettingsCollection

Public Shared ReadOnly Property ConnectionStrings As ConnectionStringSettingsCollection

Property Value

ConnectionStringSettingsCollection

A ConnectionStringSettingsCollection object that contains the contents of the ConnectionStringsSection object for the current Web application's default configuration.

Exceptions

ConfigurationErrorsException

A valid ConnectionStringSettingsCollection object could not be retrieved.

Examples

The following example shows how to use the ConnectionStrings property to access configuration information and enumerate the results. To access a specific connection string, use the returned ConnectionStringSettingsCollection with the name of the desired connection string as an indexer.


// Show the use of the ConnectionString property
// to get the connection strings.
static void GetConnectionStrings()
{

    // Get the connectionStrings key,value pairs collection.
    ConnectionStringSettingsCollection connectionStrings =
        WebConfigurationManager.ConnectionStrings
        as ConnectionStringSettingsCollection;

    // Get the collection enumerator.
    IEnumerator connectionStringsEnum =
        connectionStrings.GetEnumerator();

    // Loop through the collection and
    // display the connectionStrings key, value pairs.
    int i = 0;
    Console.WriteLine("[Display connectionStrings]");
    while (connectionStringsEnum.MoveNext())
    {
        string name = connectionStrings[i].Name;
        Console.WriteLine("Name: {0} Value: {1}",
        name, connectionStrings[name]);
        i += 1;
    }

    Console.WriteLine();
}

' Show the use of ConnectionStrings property
' to get the connection strings. 
Shared Sub GetConnectionStrings()
   
   ' Get the connectionStrings key,value pairs collection.
     Dim connectionStrings As ConnectionStringSettingsCollection = _
     WebConfigurationManager.ConnectionStrings
   
   ' Get the collection enumerator.
     Dim connectionStringsEnum As IEnumerator = _
     connectionStrings.GetEnumerator()
   
   ' Loop through the collection and 
   ' display the connectionStrings key, value pairs.
   Dim i As Integer = 0
   Console.WriteLine("[Display connectionStrings]")
   While connectionStringsEnum.MoveNext()
      Dim name As String = connectionStrings(i).Name
         Console.WriteLine("Name: {0} Value: {1}", _
         name, connectionStrings(name))
      i += 1
   End While
   
   Console.WriteLine()
End Sub

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via