This documentation is archived and is not being maintained.

DataTableMappingCollection.GetTableMappingBySchemaAction Method

Gets a DataColumnMapping object with the specified source table name and DataSet table name, using the given MissingMappingAction.

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

public static DataTableMapping GetTableMappingBySchemaAction(
	DataTableMappingCollection tableMappings,
	string sourceTable,
	string dataSetTable,
	MissingMappingAction mappingAction
)

Parameters

tableMappings
Type: System.Data.Common.DataTableMappingCollection
The DataTableMappingCollection collection to search.
sourceTable
Type: System.String
The case-sensitive name of the mapped source table.
dataSetTable
Type: System.String
The name, which is not case-sensitive, of the mapped DataSet table.
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 DataTableMapping exists in the collection, it is returned.

If the DataTableMapping does not exist in the collection for a given MissingMappingAction, the following happens:

MissingMappingAction

Action taken

Passthrough

Creates a DataTableMapping object with the given sourceTable as the source table name and dataSetTable as the DataSet table name. The created DataTableMapping object is not added to the collection.

Error

An exception is generated. The dataSetTable parameter is ignored.

Ignore

Gets null. The dataSetTable parameter is ignored.

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


public void FindDataTableMapping() 
{
    // ...
    // create mappings and mapping
    // ...
    if (mappings.Contains("Categories")) 
    {
        mapping = DataTableMappingCollection.GetTableMappingBySchemaAction
            (mappings, "Categories", "", MissingMappingAction.Ignore);
    }
}


.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: