ConfigurationElementCollection.BaseClear Method

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

ConfigurationElementCollection.cs

Removes all configuration element objects from the collection.

protected:
 void BaseClear();

protected void BaseClear ();

member this.BaseClear : unit -> unit

Protected Sub BaseClear ()

Exceptions

ConfigurationErrorsException

The configuration is read-only.

-or-

A collection item has been locked in a higher-level configuration.

Examples

The following code example shows how to call the BaseClear method.

public void Remove(UrlConfigElement url)
{
    if (BaseIndexOf(url) >= 0)
    {
        BaseRemove(url.Name);
        // Your custom code goes here.
        Console.WriteLine("UrlsCollection: {0}", "Removed collection element!");
    }
}

Public Sub Remove(ByVal url As UrlConfigElement)
    If BaseIndexOf(url) >= 0 Then
        BaseRemove(url.Name)
        ' Your custom code goes here.
        Console.WriteLine("UrlsCollection: {0}", "Removed collection element!")
    End If
End Sub

Remarks

When the BaseClear method is called, it removes all ConfigurationElement objects from the collection. It also inserts a clear directive into the configuration file.