Windows apps
Collapse the table of content
Expand the table of content
Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SqlDataReader::GetOrdinal Method (String^)

.NET Framework (current version)
 

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

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

C#
C++
F#
VB
Copy 
public:
virtual int GetOrdinal(
	String^ name
) override

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^)

Exception Condition
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 (a case-insensitive comparison is done using the database collation). Unexpected results can occur when comparisons are affected by culture-specific casing rules. For example, in Turkish, the following example yields the wrong results because the file system in Turkish does not use linguistic casing rules for the letter 'i' in "file". 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.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show:
© 2017 Microsoft