Export (0) Print
Expand All

OleDbDataReader.GetOrdinal Method

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

Namespace: System.Data.OleDb
Assembly: System.Data (in system.data.dll)

'Declaration
Public Overrides Function GetOrdinal ( _
	name As String _
) As Integer
'Usage
Dim instance As OleDbDataReader
Dim name As String
Dim returnValue As Integer

returnValue = instance.GetOrdinal(name)
public int GetOrdinal (
	String name
)
public override function GetOrdinal (
	name : String
) : int
Not applicable.

Parameters

name

The name of the column.

Return Value

The zero-based column ordinal.

Exception typeCondition

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 is made. The method throws an IndexOutOfRange exceptionif 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 one time and assigning the results to an integer variable for use within the loop.

The following example demonstrates how to use the GetOrdinal method.

Public Sub ReadData(ByVal connectionString As String)
    Dim queryString As String = "SELECT DISTINCT CustomerID FROM Orders"

    Using connection As New OleDbConnection(connectionString)
        Dim command As New OleDbCommand(queryString, connection)

        connection.Open()

        Dim reader As OleDbDataReader = command.ExecuteReader()

        Dim customerID As Integer = reader.GetOrdinal("CustomerID")
        While reader.Read()
            Console.WriteLine("CustomerID={0}", reader.GetString(customerID))
        End While
        reader.Close()
    End Using
End Sub

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft