Export (0) Print
Expand All

SqlDataReader.GetTextReader Method

.NET Framework 4.5

Retrieves Char, NChar, NText, NVarChar, text, varChar, and Variant data types as a TextReader.

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

'Declaration
Public Overrides Function GetTextReader ( _
	i As Integer _
) As TextReader

Parameters

i
Type: System.Int32

The column to be retrieved.

Return Value

Type: System.IO.TextReader
The returned object.

ExceptionCondition
InvalidOperationException

The connection drops or is closed during the data retrieval.

The SqlDataReader 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

SqlException exceptions raised from TextReader are thrown as IOException exceptions; check the inner exception for the SqlException.

Null values will be returned as an empty (zero bytes) TextReader.

GetChars will raise an InvalidOperationException exception when used on an object returned by GetTextReader when SequentialAccess is in effect.

When the connection property ContextConnection=true, GetTextReader only supports synchronous data retrieval for both sequential (SequentialAccess) and non-sequential (Default) access.

For more information, see SqlClient Streaming Support.

.NET Framework

Supported in: 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft