This documentation is archived and is not being maintained.

DataColumnMappingCollection.GetColumnMappingBySchemaAction Method

Gets a DataColumnMapping for the specified DataColumnMappingCollection, source column name, and MissingMappingAction.

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

public static DataColumnMapping GetColumnMappingBySchemaAction(
	DataColumnMappingCollection columnMappings,
	string sourceColumn,
	MissingMappingAction mappingAction
)

Parameters

columnMappings
Type: System.Data.Common.DataColumnMappingCollection

The DataColumnMappingCollection.

sourceColumn
Type: System.String

The case-sensitive source column name to find.

mappingAction
Type: System.Data.MissingMappingAction

One of the MissingMappingAction values.

ExceptionCondition
InvalidOperationException

The mappingAction parameter was set to Error, and no mapping was specified.

If the DataColumnMapping exists in the collection, it is returned.

If the DataColumnMapping does not exist in the collection, for a given MissingMappingAction, the following actions occur:

MissingMappingAction

Action Taken

Passthrough

Creates a DataColumnMapping with the specified source column name as both the source column name and the DataSet column name. This DataColumnMapping is not added to the collection.

Error

An InvalidOperationException is generated if the specified column mapping is missing.

Ignore

Gets a null value.

The following example searches for a DataColumnMapping with the given source column name within the collection. If the object exists, it is returned. The example assumes that a DataColumnMappingCollection collection and a DataColumnMapping object have been created.

public void FindDataColumnMapping() 
{
    // ... 
    // create mappings and mapping 
    // ... 
    if (mappings.Contains("Description"))
        mapping = DataColumnMappingCollection.GetColumnMappingBySchemaAction
            (mappings, "Description", MissingMappingAction.Ignore);
}

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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.

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: