ConnectionStringSettingsCollection.Clear Method

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-preview.3.24172.9

Source:

ConnectionStringSettingsCollection.cs

Removes all the ConnectionStringSettings objects from the collection.

public:
 void Clear();

public void Clear ();

member this.Clear : unit -> unit

Public Sub Clear ()

Examples

The following example shows how to remove all the ConnectionStringSettings objects from the ConnectionStringSettingsCollection collection.

// Clear connection strings collection.
static void ClearConnectionStrings()
{

    // Get the configuration file.
    System.Configuration.Configuration config =
        ConfigurationManager.OpenExeConfiguration(
        ConfigurationUserLevel.None);

    // Clear the connection strings collection.
    ConnectionStringsSection csSection =
        config.ConnectionStrings;
    csSection.ConnectionStrings.Clear();
   
    // Save the configuration file.
    config.Save(ConfigurationSaveMode.Modified);

    Console.WriteLine("Connection strings cleared.");
}

' Clear connection strings collection.
Shared Sub ClearConnectionStrings() 
    
    ' Get the application configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)

    ' Clear the connection strings collection.
    Dim csSection _
    As ConnectionStringsSection = _
    config.ConnectionStrings
    csSection.ConnectionStrings.Clear()
    
    ' Save the configuration file.
    config.Save(ConfigurationSaveMode.Modified)
    
    Console.WriteLine("Connection strings cleared.")

End Sub

Remarks

The Clear method removes all the connection strings from the configuration file at the current configuration hierarchy level and writes a <clear> tag in the file. The <clear> tag signifies that all the connection strings defined in the parent configuration files are disregarded by the system.

See also

• ConnectionStringsSection