DataTableReader.GetName(Int32) Method

Reference

Definition

Namespace:: System.Data

Assemblies:: netstandard.dll, System.Data.Common.dll

Assembly:: System.Data.Common.dll

Assembly:: System.Data.dll

Assembly:: netstandard.dll

Source:: DataTableReader.cs

Source:: DataTableReader.cs

Source:: DataTableReader.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to

Product	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via