DataTableMapping.GetColumnMappingBySchemaAction Method (String, MissingMappingAction)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

Exception Condition
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
Available since 1.1
Return to top
Show: