Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetTextReader Method

DbDataReader.GetTextReader Method

.NET Framework 4.6 and 4.5

Retrieves data as a TextReader.

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

public virtual TextReader GetTextReader(
	int ordinal
)

Parameters

ordinal
Type: System.Int32

Retrieves data as a TextReader.

Return Value

Type: System.IO.TextReader
The returned object.

ExceptionCondition
InvalidOperationException

The connection drops or is closed during the data retrieval.

The DbDataReader is closed during the data retrieval.

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

Tried to read a previously-read column in sequential mode.

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

Trying to read a column that does not exist.

InvalidCastException

The returned type was not one of the types below:

  • char

  • nchar

  • ntext

  • nvarchar

  • text

  • varchar

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

For more information, see SqlClient Streaming Support.

.NET Framework

Supported in: 4.6, 4.5
Show:
© 2015 Microsoft