DataReaderExtensions.GetTextReader(DbDataReader, String) Method

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Source:

DataReaderExtensions.cs

Gets a text reader to retrieve data from the column.

public:
[System::Runtime::CompilerServices::Extension]
 static System::IO::TextReader ^ GetTextReader(System::Data::Common::DbDataReader ^ reader, System::String ^ name);

public static System.IO.TextReader GetTextReader (this System.Data.Common.DbDataReader reader, string name);

static member GetTextReader : System.Data.Common.DbDataReader * string -> System.IO.TextReader

<Extension()>
Public Function GetTextReader (reader As DbDataReader, name As String) As TextReader

Parameters

reader

DbDataReader

The data reader to get the column value from.

name

String

The name of the column.

Returns

TextReader

A text reader.

Exceptions

InvalidOperationException

The connection was dropped or closed during the data retrieval.

-or-

The data reader is closed during the data retrieval.

-or-

There is no data ready to be read (for example, the first Read() hasn't been called, or returned false).

-or-

The data reader tried to read a previously-read column in sequential mode.

-or-

There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream.

IndexOutOfRangeException

The name specified is not a valid column name.

InvalidCastException

The specified column isn't a text type that supports reading with a TextReader.

Remarks

GetTextReader only supports the retrieval of values that can be converted to character arrays (strings).