ConnectionStringSettings Class
Represents a single, named connection string in the connection strings configuration file section.
System.Configuration.ConfigurationElement
System.Configuration.ConnectionStringSettings
Namespace: System.Configuration
Assembly: System.Configuration (in System.Configuration.dll)
The ConnectionStringSettings type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ConnectionStringSettings() | Initializes a new instance of a ConnectionStringSettings class. |
![]() | ConnectionStringSettings(String, String) | Initializes a new instance of a ConnectionStringSettings class. |
![]() | ConnectionStringSettings(String, String, String) | Initializes a new instance of a ConnectionStringSettings object. |
| Name | Description | |
|---|---|---|
![]() | ConnectionString | Gets or sets the connection string. |
![]() | CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.) |
![]() | ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.) |
![]() | Item[ConfigurationProperty] | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
![]() | Item[String] | Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.) |
![]() | LockAllAttributesExcept | Gets the collection of locked attributes. (Inherited from ConfigurationElement.) |
![]() | LockAllElementsExcept | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockAttributes | Gets the collection of locked attributes (Inherited from ConfigurationElement.) |
![]() | LockElements | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockItem | Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.) |
![]() | Name | Gets or sets the ConnectionStringSettings name. |
![]() | Properties | Gets the collection of properties. (Inherited from ConfigurationElement.) |
![]() | ProviderName | Gets or sets the provider name property. |
| Name | Description | |
|---|---|---|
![]() | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
![]() | Equals | Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.) |
![]() | GetHashCode | Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Init | Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.) |
![]() | InitializeDefault | Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | IsModified | Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | IsReadOnly | Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.) |
![]() | Reset | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.) |
![]() | ResetModified | Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SerializeElement | Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SetReadOnly | Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.) |
![]() | ToString | Returns a string representation of the object. (Overrides Object.ToString().) |
![]() | Unmerge | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.) |
A ConnectionStringSettings object represents a single entry in the connectionStrings configuration file section.
| Topic | Location |
|---|---|
| How to: Access SQL Server Using Predetermined Credentials | Building ASP .NET Web Applications |
| How to: Read Connection Strings from the Web.config File | Configuring ASP .NET Web Applications |
| How to: Secure Connection Strings When Using Data Source Controls | Building ASP .NET Web Applications |
| How to: Read Connection Strings from the Web.config File | Configuring ASP .NET Web Applications |
| How to: Access SQL Server Using Predetermined Credentials | Building ASP .NET Web Applications |
| How to: Secure Connection Strings When Using Data Source Controls | Building ASP .NET Web Applications |
| How To: Secure Connection Strings when Using Data Source Controls (Visual Studio) | Building ASP .NET Web Applications in Visual Studio |
The following example shows how to access a ConnectionStringSettings object at a given index in a ConnectionStringSettingsCollection collection.
using System; using System.Collections.Generic; using System.Configuration; using System.Web.Configuration; using System.Collections; using System.Text; namespace ConfigurationStringSettings { class ConfigurationStringSettings { static void DisplayConnectionStrings() { // Set the path of the config file. // Make sure that you have a Web site on the // same server called TestConfig. string configPath = "/TestConfig"; // Get the Web application configuration object. Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath); // Get the conectionStrings section. ConnectionStringsSection csSection = config.ConnectionStrings; Console.WriteLine("Display configuration strings."); 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); } } static void Main(string[] args) { try { // Display connection strings. DisplayConnectionStrings(); } catch (Exception e) { // Unknown error. Console.WriteLine(e.ToString()); } // Display and wait. Console.WriteLine("Enter any key to exit."); Console.ReadLine(); } } }
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
