StreamReader Constructor (String, Encoding, Boolean)
Initializes a new instance of the StreamReader class for the specified file name, with the specified character encoding and byte order mark detection option.
Assembly: mscorlib (in mscorlib.dll)
new : path:string * encoding:Encoding * detectEncodingFromByteOrderMarks:bool -> StreamReader
path is an empty string ("").
path or encoding is a null reference (Nothing in Visual Basic).
The file cannot be found.
The specified path is invalid, such as being on an unmapped drive.
path includes an incorrect or invalid syntax for file name, directory name, or volume label.
This constructor initializes the encoding as specified by the encoding parameter, and the internal buffer size to 1024 bytes.
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 user-provided encoding is used. See the Encoding.GetPreamble method for more information.
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.
When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.
For a list of common I/O tasks, see Common I/O Tasks.