TextReader Class

May 11, 2014

Represents a reader that can read a sequential series of characters.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)

public abstract class TextReader : IDisposable

The TextReader type exposes the following members.

  NameDescription
Protected methodTextReaderInitializes a new instance of the TextReader class.
Top

  NameDescription
Public methodCloseCloses the TextReader and releases any system resources associated with the TextReader.
Public methodDispose()Releases all resources used by the TextReader object.
Protected methodDispose(Boolean)Releases the unmanaged resources used by the TextReader and optionally releases the managed resources.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPeekReads the next character without changing the state of the reader or the character source. Returns the next available character without actually reading it from the input stream.
Public methodRead()Reads the next character from the input stream and advances the character position by one character.
Public methodRead(Char[], Int32, Int32)Reads a maximum of count characters from the current stream and writes the data to buffer, beginning at index.
Public methodReadAsyncReads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.
Public methodReadBlockReads a maximum of count characters from the current stream, and writes the data to buffer, beginning at index.
Public methodReadBlockAsyncReads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.
Public methodReadLineReads a line of characters from the current stream and returns the data as a string.
Public methodReadLineAsyncReads a line of characters asynchronously and returns the data as a string.
Public methodReadToEndReads all characters from the current position to the end of the TextReader and returns them as one string.
Public methodReadToEndAsyncReads all characters from the current position to the end of the text reader asynchronously and returns them as one string.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberNullProvides a TextReader with no data to read from.
Top

TextReader is the abstract base class of StreamReader and StringReader, which read characters from streams and strings, respectively. Use these derived classes to open a text file for reading a specified range of characters, or to create a reader based on an existing stream.

Notes to Inheritors

A derived class must minimally implement the Peek and Read methods to make a useful instance of TextReader.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft