GetName Method

DataTableReader.GetName Method (Int32)

 

Gets the value of the specified column as a String.

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

Public Overrides Function GetName (
	ordinal As Integer
) As String

Parameters

ordinal
Type: System.Int32

The zero-based column ordinal

Return Value

Type: System.String

The name of the specified column.

Exception Condition
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 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

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft