DataTableMappingCollection.GetTableMappingBySchemaAction Method

Reference

Definition

Namespace:: System.Data.Common

Assembly:: System.Data.Common.dll

Assembly:: System.Data.dll

Assembly:: netstandard.dll

Source:: DataTableMappingCollection.cs

Source:: DataTableMappingCollection.cs

Source:: DataTableMappingCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 static System::Data::Common::DataTableMapping ^ GetTableMappingBySchemaAction(System::Data::Common::DataTableMappingCollection ^ tableMappings, System::String ^ sourceTable, System::String ^ dataSetTable, System::Data::MissingMappingAction mappingAction);

public static System.Data.Common.DataTableMapping? GetTableMappingBySchemaAction (System.Data.Common.DataTableMappingCollection? tableMappings, string sourceTable, string dataSetTable, System.Data.MissingMappingAction mappingAction);

public static System.Data.Common.DataTableMapping GetTableMappingBySchemaAction (System.Data.Common.DataTableMappingCollection tableMappings, string sourceTable, string dataSetTable, System.Data.MissingMappingAction mappingAction);

static member GetTableMappingBySchemaAction : System.Data.Common.DataTableMappingCollection * string * string * System.Data.MissingMappingAction -> System.Data.Common.DataTableMapping

Public Shared Function GetTableMappingBySchemaAction (tableMappings As DataTableMappingCollection, sourceTable As String, dataSetTable As String, mappingAction As MissingMappingAction) As DataTableMapping

Parameters

tableMappings: DataTableMappingCollection

The DataTableMappingCollection collection to search.

sourceTable: String

The case-sensitive name of the mapped source table.

dataSetTable: String

The name, which is not case-sensitive, of the mapped DataSet table.

mappingAction: MissingMappingAction

One of the MissingMappingAction values.

Returns

DataTableMapping

A DataTableMapping object.

Exceptions

InvalidOperationException

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

Examples

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);
    }
}

Public Sub FindDataTableMapping()
    ' ...
    ' create mappings and mapping
    ' ...
    If mappings.Contains("Categories") Then
        mapping = _
           DataTableMappingCollection.GetTableMappingBySchemaAction _
           (mappings, "Categories", "", MissingMappingAction.Ignore)
    End If
End Sub

Remarks

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.

Applies to

Del via