Export (0) Print
Expand All

StreamReader Constructor (String, Boolean)

Initializes a new instance of the StreamReader class for the specified file name, with the specified byte order mark detection option.

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

new : 
        path:string * 
        detectEncodingFromByteOrderMarks:bool -> StreamReader

Parameters

path
Type: System.String
The complete file path to be read.
detectEncodingFromByteOrderMarks
Type: System.Boolean
Indicates whether to look for byte order marks at the beginning of the file.

ExceptionCondition
ArgumentException

path is an empty string ("").

ArgumentNullException

path is a null reference (Nothing in Visual Basic).

FileNotFoundException

The file cannot be found.

DirectoryNotFoundException

The specified path is invalid, such as being on an unmapped drive.

IOException

path includes an incorrect or invalid syntax for file name, directory name, or volume label.

This constructor initializes the encoding to UTF8Encoding, the BaseStream property using the stream parameter, and the internal buffer size to 1024 bytes.

The path parameter can be a file name, including a file on a Universal Naming Convention (UNC) share.

The path parameter is not required to be a file stored on disk; it can be any part of a system that supports access using streams.

The detectEncodingFromByteOrderMarks parameter detects the encoding by looking at the first three bytes of the stream. It automatically recognizes UTF-8, little-endian Unicode, and big-endian Unicode text if the file starts with the appropriate byte order marks. Otherwise, the UTF8Encoding is used. See the Encoding.GetPreamble method for more information.

For a list of common I/O tasks, see Common I/O Tasks.

The following code example demonstrates this StreamReader constructor.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft