Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ConnectionStringSettings Class
Definition
- Namespace:
- System.Configuration
- Assembly:
- System.Configuration.ConfigurationManager.dll
- Assembly:
- System.Configuration.dll
- Package:
- System.Configuration.ConfigurationManager v11.0.0-preview.5.26302.115
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
- Source:
- ConnectionStringSettings.cs
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.
Represents a single, named connection string in the connection strings configuration file section.
public ref class ConnectionStringSettings sealed : System::Configuration::ConfigurationElement
public sealed class ConnectionStringSettings : System.Configuration.ConfigurationElement
type ConnectionStringSettings = class
inherit ConfigurationElement
Public NotInheritable Class ConnectionStringSettings
Inherits ConfigurationElement
- Inheritance
Examples
The following example shows how to access a ConnectionStringSettings object at a given index in a ConnectionStringSettingsCollection collection.
using System;
using System.Configuration;
using System.Web.Configuration;
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();
}
}
}
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
Remarks
A ConnectionStringSettings object represents a single entry in the connectionStrings configuration file section.
Constructors
| Name | Description |
|---|---|
| ConnectionStringSettings() |
Initializes a new instance of the ConnectionStringSettings class. |
| ConnectionStringSettings(String, String, String) |
Initializes a new instance of the ConnectionStringSettings class. |
| ConnectionStringSettings(String, String) |
Initializes a new instance of the ConnectionStringSettings class. |
Properties
| 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) |
| EvaluationContext |
Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement) |
| HasContext |
Gets a value that indicates whether the CurrentConfiguration property is |
| 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. |
Methods
| Name | Description |
|---|---|
| DeserializeElement(XmlReader, Boolean) |
Reads XML from the configuration file. (Inherited from ConfigurationElement) |
| Equals(Object) |
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) |
| GetTransformedAssemblyString(String) |
Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement) |
| GetTransformedTypeString(String) |
Returns the transformed version of the specified type name. (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) |
| ListErrors(IList) |
Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Throws an exception when a required property is not found. (Inherited from ConfigurationElement) |
| PostDeserialize() |
Called after deserialization. (Inherited from ConfigurationElement) |
| PreSerialize(XmlWriter) |
Called before serialization. (Inherited from ConfigurationElement) |
| Reset(ConfigurationElement) |
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 |
| SerializeElement(XmlWriter, Boolean) |
Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement) |
| SerializeToXmlElement(XmlWriter, String) |
Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Sets a property to the specified value. (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. |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement) |
Applies to
See also
Feedback
Was this page helpful?
