DataTableReader.GetOrdinal メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

DataTableReader.GetOrdinal メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

列の名前を指定して、列の序数を取得します。

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

Visual Basic (宣言)

Public Overrides Function
 GetOrdinal ( _
    name As String _
) As Integer

Visual Basic (使用法)

Dim instance As DataTableReader
Dim name As String
Dim returnValue As Integer

returnValue = instance.GetOrdinal(name)

public override int GetOrdinal (
    string name
)

C++

public:
virtual int GetOrdinal (
    String^ name
) override

public int GetOrdinal (
    String name
)

JScript

public override function GetOrdinal (
    name : String
) : int

パラメータ

name: 列の名前。

戻り値
列の 0 から始まる序数。

例外

例外の種類	条件
InvalidOperationException	閉じている DataTableReader の列を読み取るかアクセスしようとしました。
ArgumentException	指定した名前が有効な列名ではありません。

解説

DataTableReader クラスで使用できるメソッドのほとんどでは序数の列番号が必要なため、GetOrdinal メソッドを使用して、指定した名前の列の列番号を取得します。

GetOrdinal は、初めに大文字と小文字を区別して検索を実行します。それに失敗した場合は、大文字と小文字を区別せずに、2 回目の検索が実行されます。

GetOrdinal では、かなの全角と半角が区別されません。

序数ベースの検索は名前ベースの検索よりも効率的なため、ループ内で GetOrdinal を呼び出すことは非効率的です。GetOrdinal を 1 回呼び出し、ループ内で使用するために結果を整数の変数に割り当てることによって、時間を節約できます。

使用例

ユーザーが指定している列名のみ判明しているときに、その列の情報を取得する必要がある場合、次のようなプロシージャを使用することで必要な情報を抽出できます。この例では、プロシージャは列名を受け取り、DataTableReader 内でその列の現在の行に格納されているデータを返します。

Visual Basic

Private Function GetValueByName( _
   ByVal reader As DataTableReader, _
   ByVal columnName As String)
 As Object

   ' Consider when to use a procedure like this one carefully:
   ' If you're going to retrieve information from a column
   ' in a loop, it would be better to retrieve the column
   ' ordinal once, store the value, and use the methods
   ' of the DataTableReader class directly. 
   Dim columnValue As Object

   Try
      Dim columnOrdinal As Integer
 = reader.GetOrdinal(columnName)
      columnValue = reader.GetValue(columnOrdinal)
   Catch ex As ArgumentException
      ' Throw all other errors back out to the caller.
      columnValue = Nothing
   End Try
   Return columnValue
End Function

private static object GetValueByName(
    DataTableReader reader, string columnName)
{
    // Consider when to use a procedure like this one carefully:
    // if you're going to retrieve information from a column
    // in a loop, it would be better to retrieve the column
    // ordinal once, store the value, and use the methods
    // of the DataTableReader class directly. 
    object columnValue;

    try
    {
        int columnOrdinal = reader.GetOrdinal(columnName);
        columnValue = reader.GetValue(columnOrdinal);
    }
    catch (ArgumentException ex)
    {
        // Throw all other errors back out to the caller.
        columnValue = null;
    }
    return columnValue;
}