DataColumnMappingCollection.GetColumnMappingBySchemaAction メソッド

.NET Framework クラス ライブラリ リファレンス

DataColumnMappingCollection.GetColumnMappingBySchemaAction メソッド

指定した DataColumnMappingCollection、ソース列名、および MissingMappingAction を使用して、DataColumnMapping を取得します。

名前空間: System.Data.Common
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Shared Function GetColumnMappingBySchemaAction
 ( _
    columnMappings As DataColumnMappingCollection, _
    sourceColumn As String, _
    mappingAction As MissingMappingAction _
) As DataColumnMapping

Visual Basic (使用法)

Dim columnMappings As DataColumnMappingCollection
Dim sourceColumn As String
Dim mappingAction As MissingMappingAction
Dim returnValue As DataColumnMapping

returnValue = DataColumnMappingCollection.GetColumnMappingBySchemaAction(columnMappings,
 sourceColumn, mappingAction)

C#

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

C++

public:
static DataColumnMapping^ GetColumnMappingBySchemaAction (
    DataColumnMappingCollection^ columnMappings, 
    String^ sourceColumn, 
    MissingMappingAction mappingAction
)

J#

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

JScript

public static function GetColumnMappingBySchemaAction
 (
    columnMappings : DataColumnMappingCollection, 
    sourceColumn : String, 
    mappingAction : MissingMappingAction
) : DataColumnMapping

パラメータ

columnMappings

DataColumnMappingCollection。

sourceColumn

検索するソース列名。大文字と小文字が区別されます。

mappingAction

MissingMappingAction 値の 1 つ。

戻り値
DataColumnMapping オブジェクト。

例外

例外の種類	条件
InvalidOperationException	mappingAction パラメータが Error に設定され、マップが指定されませんでした。

解説

コレクション内に目的の DataColumnMapping が存在する場合は、そのマップが返されます。

コレクション内に目的の DataColumnMapping が存在しない場合は、指定した MissingMappingAction によって、次のアクションが実行されます。

MissingMappingAction	アクション
Passthrough	指定したソース列名をソース列と DataSet 列の両方の名前として使用して、DataColumnMapping を作成します。この DataColumnMapping はコレクションには追加されません。
Error	指定した列マップが存在しない場合は、InvalidOperationException が生成されます。
Ignore	null 値を取得します。

使用例

コレクション内で、指定したソース列名が含まれる DataColumnMapping を検索する例を次に示します。目的のオブジェクトが存在する場合は、そのオブジェクトを返します。この例では、DataColumnMappingCollection コレクションと DataColumnMapping オブジェクトが作成されていることを前提にしています。

Visual Basic

Public Sub FindDataColumnMapping()
    ' ...
    ' create mappings and mapping
    ' ...
    If mappings.Contains("Description")
 Then
        mapping = _
           DataColumnMappingCollection.GetColumnMappingBySchemaAction _
           (mappings, "Description", MissingMappingAction.Ignore)
    End If
End Sub

C#

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
DataColumnMappingCollection クラス
DataColumnMappingCollection メンバ
System.Data.Common 名前空間