Export (0) Print
Expand All

DataTableReader.GetName Method

Gets the value of the specified column as a String.

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

public override string GetName(
	int ordinal
)

Parameters

ordinal
Type: System.Int32

The zero-based column ordinal

Return Value

Type: System.String
The name of the specified column.

Implements

IDataRecord.GetName(Int32)

ExceptionCondition
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.

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.

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));
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft