DataTableReader.GetName(Int32) Method

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Source:

DataTableReader.cs

Gets the value of the specified column as a String.

public:
 override System::String ^ GetName(int ordinal);

public override string GetName (int ordinal);

override this.GetName : int -> string

Public Overrides Function GetName (ordinal As Integer) As String

Parameters

ordinal

Int32

The zero-based column ordinal.

Returns

String

The name of the specified column.

Exceptions

ArgumentOutOfRangeException

The index passed was outside the range of 0 to FieldCount - 1.

InvalidOperationException

An attempt was made to read or access a column in a closed DataTableReader.

Examples

The following simple example includes a procedure that lists the names of all the columns within the specified DataTableReader, and the column's ordinal position, to the Console window.

private static void DisplayColumnNames(DataTableReader reader)
{
    // Given a DataTableReader, display column names.
    for (int i = 0; i < reader.FieldCount; i++)
    {
        Console.WriteLine("{0}: {1}", i, reader.GetName(i));
    }
}

Private Sub DisplayColumnNames(ByVal reader As DataTableReader)
   ' Given a DataTableReader, display column names.
   For i As Integer = 0 To reader.FieldCount - 1
      Console.WriteLine("{0}: {1}", i, reader.GetName(i))
   Next
End Sub

Remarks

The GetName and GetOrdinal methods provide inverse functionality. That is, calling GetOrdinal on the return value of calling GetName should return the original parameter passed to GetName; the same applies to calling the procedures in the opposite order.