StreamReader Class

Article
01/16/2013

[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.

Inheritance Hierarchy

System. . :: . .Object
  System. . :: . .MarshalByRefObject
    System.IO. . :: . .TextReader
      System.IO..::..StreamReader

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

Syntax

'Declaration
Public Class StreamReader _
    Inherits TextReader

public class StreamReader : TextReader

public ref class StreamReader : public TextReader

type StreamReader =  
    class
        inherit TextReader
    end

public class StreamReader extends TextReader

The StreamReader type exposes the following members.

Constructors

	Name	Description
	StreamReader(Stream)	Initializes a new instance of the StreamReader class for the specified stream.
	StreamReader(String)	Initializes a new instance of the StreamReader class for the specified file name.

Top

Properties

	Name	Description
	BaseStream	Returns the underlying stream.
	CurrentEncoding	Gets the current character encoding that the current StreamReader object is using.
	EndOfStream	Gets a value that indicates whether the current stream position is at the end of the stream.

Top

Methods

	Name	Description
	Close	Closes the StreamReader object and the underlying stream, and releases any system resources associated with the reader. (Overrides TextReader. . :: . .Close() () () ().)
	Dispose() () () ()	Releases all resources used by the TextReader object. (Inherited from TextReader.)
	Dispose(Boolean)	Closes the underlying stream, releases the unmanaged resources used by the StreamReader, and optionally releases the managed resources. (Overrides TextReader. . :: . .Dispose(Boolean).)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Peek	Returns the next available character but does not consume it. (Overrides TextReader. . :: . .Peek() () () ().)
	Read() () () ()	Reads the next character from the input stream and advances the character position by one character. (Overrides TextReader. . :: . .Read() () () ().)
	Read(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).)
	ReadBlock	Reads 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.)
	ReadLine	Reads a line of characters from the current stream and returns the data as a string. (Overrides TextReader. . :: . .ReadLine() () () ().)
	ReadToEnd	Reads all characters from the current position to the end of the stream. (Overrides TextReader. . :: . .ReadToEnd() () () ().)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

Thread Safety

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

Share via