DataTableReader.GetDateTime(Int32) Method

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Source:

DataTableReader.cs

Gets the value of the specified column as a DateTime object.

public:
 override DateTime GetDateTime(int ordinal);

public override DateTime GetDateTime (int ordinal);

override this.GetDateTime : int -> DateTime

Public Overrides Function GetDateTime (ordinal As Integer) As DateTime

Parameters

ordinal

Int32

The zero-based column ordinal.

Returns

DateTime

The value of the specified column.

Exceptions

ArgumentOutOfRangeException

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

DeletedRowInaccessibleException

An attempt was made to retrieve data from a deleted row.

InvalidOperationException

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

InvalidCastException

The specified column does not contain a DateTime value.

Examples

The following example displays the contents of the column numbered 2 within the passed-in DataTableReader. If the value the column within a particular row is null, the code displays the text <NULL>. If the data within the column is not of the correct type, the example displays an error message for each row.

private static void PrintColumn(DataTableReader reader)
{
    // Loop through all the rows in the DataTableReader
    while (reader.Read())
    {
        if (reader.IsDBNull(2))
        {
            Console.Write("<NULL>");
        }
        else
        {
            try
            {
                Console.Write(reader.GetDateTime(2));
            }
            catch (InvalidCastException)
            {
                Console.Write("Invalid data type.");
            }
        }
        Console.WriteLine();
    }
}

Private Sub PrintColumn(ByVal reader As DataTableReader)
   ' Loop through all the rows in the DataTableReader
   While reader.Read()
      If reader.IsDBNull(2) Then
         Console.Write("<NULL>")
      Else
         Try
            Console.Write(reader.GetDateTime(2))
         Catch ex As InvalidCastException
            Console.Write("Invalid data type.")
         End Try
      End If
      Console.WriteLine()
   End While
End Sub

Remarks

No conversions are performed; therefore the data retrieved must already be a DateTime or coercible to a DataTime.

Call IsDBNull to see if there are null values before calling this method.