ConfigurationElementCollection.BaseRemove Method (System.Configuration)

BaseRemove Method

.NET Framework Class Library

ConfigurationElementCollection..::.BaseRemove Method

Removes a ConfigurationElement from the collection.

Namespace: System.Configuration
Assembly: System.Configuration (in System.Configuration.dll)

Syntax

Visual Basic (Declaration)

Protected Friend Sub BaseRemove ( _
    key As Object _
)

Visual Basic (Usage)

Dim key As Object

Me.BaseRemove(key)

protected internal void BaseRemove(
    Object key
)

Visual C++

protected public:
void BaseRemove(
    Object^ key
)

JScript

protected internal function BaseRemove(
    key : Object
)

Parameters

key: Type: System..::.Object
The key of the ConfigurationElement to remove.

Exceptions

Exception	Condition
Exception	No ConfigurationElement with the specified key exists in the collection, the element has already been removed, or the element cannot be removed because the value of its Type is not AddRemoveClearMap.

Remarks

The BaseRemove method inserts a <remove> directive into the configuration file for the ConfigurationElement with the specified key.

Examples

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

Visual Basic

Public Overloads Sub Remove( _
    ByVal url As UrlConfigElement)

    If BaseIndexOf(url) >= 0 Then
        BaseRemove(url.Name)
    End If
End Sub 'Remove

public void Remove(UrlConfigElement url)
{
    if (BaseIndexOf(url) >= 0)
        BaseRemove(url.Name);
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

ConfigurationElementCollection Class

ConfigurationElementCollection Members

System.Configuration Namespace