StreamReader Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Implements a TextReader that reads characters from a byte stream in a particular encoding.

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

'Declaration
Public Class StreamReader _
	Inherits TextReader

The StreamReader type exposes the following members.

  NameDescription
Public methodStreamReader(Stream)Initializes a new instance of the StreamReader class for the specified stream.
Public methodStreamReader(String)Initializes a new instance of the StreamReader class for the specified file name.
Top

  NameDescription
Public propertyBaseStreamReturns the underlying stream.
Public propertyCurrentEncodingGets the current character encoding that the current StreamReader object is using.
Public propertyEndOfStreamGets a value that indicates whether the current stream position is at the end of the stream.
Top

  NameDescription
Public methodCloseCloses the StreamReader object and the underlying stream, and releases any system resources associated with the reader. (Overrides TextReader..::..Close()()()().)
Public methodDispose()()()()Releases all resources used by the TextReader object. (Inherited from TextReader.)
Protected methodDispose(Boolean)Closes the underlying stream, releases the unmanaged resources used by the StreamReader, and optionally releases the managed resources. (Overrides TextReader..::..Dispose(Boolean).)
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 it 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 methodPeekReturns the next available character but does not consume it. (Overrides TextReader..::..Peek()()()().)
Public methodRead()()()()Reads the next character from the input stream and advances the character position by one character. (Overrides TextReader..::..Read()()()().)
Public methodRead(array<Char>[]()[][], Int32, Int32)Reads a specified maximum of characters from the current stream into a buffer, beginning at the specified index. (Overrides TextReader..::..Read(array<Char>[]()[][], Int32, Int32).)
Public methodReadBlockReads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index. (Inherited from TextReader.)
Public methodReadLineReads a line of characters from the current stream and returns the data as a string. (Overrides TextReader..::..ReadLine()()()().)
Public methodReadToEndReads all characters from the current position to the end of the stream. (Overrides TextReader..::..ReadToEnd()()()().)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

StreamReader is designed for character input in a particular encoding, whereas the Stream class is designed for byte input and output. Use StreamReader for reading lines of information from a standard text file.

StreamReader defaults to UTF-8 encoding unless specified otherwise, instead of defaulting to the ANSI code page for the current system. UTF-8 handles Unicode characters correctly and provides consistent results on localized versions of the operating system.

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: