GetOrdinal Method

IDataRecord.GetOrdinal Method (String)


Return the index of the named field.

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

int GetOrdinal(
	string name


Type: System.String

The name of the field to find.

Return Value

Type: System.Int32

The index of the named field.

GetOrdinal performs a case-sensitive lookup first. If it fails, a second case-insensitive search is made. GetOrdinal is kana-width insensitive. If the index of the named field is not found, an IndexOutOfRangeException is thrown.

Because ordinal-based lookups are more efficient than named lookups, it is inefficient to call GetOrdinal within a loop. Save time by calling GetOrdinal one time and assigning the results to an integer variable for use within the loop.

The following example demonstrates how to use the inherited GetOrdinal method.

public static void ReadData(string connectionString)
    string queryString = "SELECT DISTINCT CustomerID FROM Orders";

    using (OdbcConnection connection = new OdbcConnection(connectionString))
        OdbcCommand command = new OdbcCommand(queryString, connection);

        OdbcDataReader reader = command.ExecuteReader();

        int customerID = reader.GetOrdinal("CustomerID");

        while (reader.Read())
            Console.WriteLine("CustomerID={0}", reader.GetString(customerID));

        // Call Close when done reading.

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft