ConnectionStringSettingsCollection.Remove ConnectionStringSettingsCollection.Remove ConnectionStringSettingsCollection.Remove ConnectionStringSettingsCollection.Remove Method

Definition

Removes a ConnectionStringSettings object from the collection.

Overloads

Remove(ConnectionStringSettings) Remove(ConnectionStringSettings) Remove(ConnectionStringSettings) Remove(ConnectionStringSettings)

Removes the specified ConnectionStringSettings object from the collection.

Remove(String) Remove(String) Remove(String) Remove(String)

Removes the specified ConnectionStringSettings object from the collection.

Remove(ConnectionStringSettings) Remove(ConnectionStringSettings) Remove(ConnectionStringSettings) Remove(ConnectionStringSettings)

Removes the specified ConnectionStringSettings object from the collection.

public:
 void Remove(System::Configuration::ConnectionStringSettings ^ settings);
public void Remove (System.Configuration.ConnectionStringSettings settings);
member this.Remove : System.Configuration.ConnectionStringSettings -> unit
Public Sub Remove (settings As ConnectionStringSettings)

Parameters

Examples

The following example shows how to remove the specified ConnectionStringSettings object from the collection.

static void RemoveConnectionStrings()
{

    try
    {
        System.Configuration.Configuration config =
         ConfigurationManager.OpenExeConfiguration(
         ConfigurationUserLevel.None);

        // Clear the connection strings collection.
        ConnectionStringsSection csSection =
            config.ConnectionStrings;
        ConnectionStringSettingsCollection csCollection =
         csSection.ConnectionStrings;

        // Get the connection string setting element
        // with the specified name.
        ConnectionStringSettings cs =
            csCollection["ConnStr0"];

        // Remove it.
        if (cs != null)
        {
            // Remove the element.
            csCollection.Remove(cs);

            // Save the configuration file.
            config.Save(ConfigurationSaveMode.Modified);
            
            Console.WriteLine(
             "Connection string settings removed.");
        }
        else
            Console.WriteLine(
                "Connection string settings does not exist.");

    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine(err.ToString());
    }
}
Shared Sub RemoveConnectionStrings() 
    
    Try
        ' 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
        Dim csCollection _
        As ConnectionStringSettingsCollection = _
        csSection.ConnectionStrings
        
        ' Get the connection string setting element
        ' with the specified name.
        Dim cs As ConnectionStringSettings = _
        csCollection("ConnStr0")
        
        ' Remove it.
        If Not (cs Is Nothing) Then
            ' Remove the element.
            csCollection.Remove(cs)
            
            ' Save the configuration file.
            config.Save(ConfigurationSaveMode.Modified)
            
            Console.WriteLine( _
            "Connection string settings removed.")
        Else
            Console.WriteLine( _
            "Connection string settings does not exist.")
        End If
    
    Catch err As ConfigurationErrorsException
        Console.WriteLine(err.ToString())
    End Try

End Sub 'RemoveConnectionStrings

See also

Remove(String) Remove(String) Remove(String) Remove(String)

Removes the specified ConnectionStringSettings object from the collection.

public:
 void Remove(System::String ^ name);
public void Remove (string name);
member this.Remove : string -> unit
Public Sub Remove (name As String)

Parameters

name
String String String String

The name of a ConnectionStringSettings object in the collection.

Examples

The following example shows how to remove the ConnectionStringSettings object with the specified name from the collection.

static void RemoveConnectionStrings2()
{

    try
    {
        System.Configuration.Configuration config =
         ConfigurationManager.OpenExeConfiguration(
         ConfigurationUserLevel.None);

        // Clear the connection strings collection.
        ConnectionStringsSection csSection =
            config.ConnectionStrings;
        ConnectionStringSettingsCollection csCollection =
         csSection.ConnectionStrings;

        // Remove the element.
            csCollection.Remove("ConnStr0");
       

        // Save the configuration file.
        config.Save(ConfigurationSaveMode.Modified);

        Console.WriteLine(
             "Connection string settings removed.");
    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine(err.ToString());
    }
}
Shared Sub RemoveConnectionStrings2() 
    
    Try
        ' 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
        Dim csCollection _
        As ConnectionStringSettingsCollection = _
        csSection.ConnectionStrings
        
        ' Remove the element.
        csCollection.Remove("ConnStr0")
        
        
        ' Save the configuration file.
        config.Save(ConfigurationSaveMode.Modified)
        
        Console.WriteLine( _
        "Connection string settings removed.")

    Catch err As ConfigurationErrorsException
        Console.WriteLine(err.ToString())
    End Try

End Sub 'RemoveConnectionStrings2

See also

Applies to