This topic has not yet been rated - Rate this topic

DataTableMapping.GetColumnMappingBySchemaAction Method

Gets a DataColumn from the specified DataTable using the specified MissingMappingAction value and the name of the DataColumn.

Namespace:  System.Data.Common
Assembly:  System.Data (in System.Data.dll)
public DataColumnMapping GetColumnMappingBySchemaAction(
	string sourceColumn,
	MissingMappingAction mappingAction
)

Parameters

sourceColumn
Type: System.String
The name of the DataColumn.
mappingAction
Type: System.Data.MissingMappingAction
One of the MissingMappingAction values.

Return Value

Type: System.Data.Common.DataColumnMapping
A data column.
ExceptionCondition
InvalidOperationException

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

If the DataColumnMapping exists, it is returned.

If the DataColumnMapping does not exist, 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.

.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.
Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.