This documentation is archived and is not being maintained.

DataColumnMappingCollection.Remove Method (Object)

Removes the Object that is a DataColumnMapping from the collection.

Namespace:  System.Data.Common
Assembly:  System.Data (in System.Data.dll)

public void Remove(
	Object value
)

Parameters

value
Type: System.Object
The Object that is the DataColumnMapping to remove.

Implements

IList.Remove(Object)

ExceptionCondition
InvalidCastException

The object specified was not a DataColumnMapping object.

ArgumentException

The object specified is not in the collection.

The following example searches for a DataColumnMapping within the collection. If the mapping exists in the collection, it is removed. If the mapping does not exist within the collection, it is added to the collection and its index is displayed. The example assumes that a DataColumnMappingCollection collection and a DataColumnMapping object have been created.


public void ChangedMyMind() 
{
    // ...
    // create mappings and mapping
    // ...
    if (mappings.Contains((Object) mapping))
        mappings.Remove((Object) mapping);
    else 
    {
        mappings.Add((Object) mapping);
        Console.WriteLine("Index of new mapping: "
            + mappings.IndexOf((Object) mapping));
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: