This documentation is archived and is not being maintained.

SqlDataReader.GetOrdinal Method

Gets the column ordinal, given the name of the column.

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

public override int GetOrdinal(
	string name
)

Parameters

name
Type: System.String

The name of the column.

Return Value

Type: System.Int32
The zero-based column ordinal.

Implements

IDataRecord.GetOrdinal(String)
IDataRecord.GetOrdinal(String)

ExceptionCondition
IndexOutOfRangeException

The name specified is not a valid column name.

GetOrdinal performs a case-sensitive lookup first. If it fails, a second, case-insensitive search occurs. The method throws an IndexOutOfRange exception if the zero-based column ordinal is not found.

GetOrdinal is kana-width insensitive.

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

The following example demonstrates how to use the GetOrdinal method.

private static void ReadGetOrdinal(string connectionString)
{
    string queryString = "SELECT DISTINCT CustomerID FROM dbo.Orders;";
    using (SqlConnection connection =
               new SqlConnection(connectionString))
    {
        SqlCommand command =
            new SqlCommand(queryString, connection);
        connection.Open();

        SqlDataReader reader = command.ExecuteReader();

        // Call GetOrdinal and assign value to variable. 
        int customerID = reader.GetOrdinal("CustomerID");

        // Use variable with GetString inside of loop. 
        while (reader.Read())
        {
            Console.WriteLine("CustomerID={0}", reader.GetString(customerID));
        }

        // Call Close when done reading.
        reader.Close();
    }
}

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Show: