StreamReader Constructor (Stream, Boolean)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Initializes a new instance of the StreamReader class for the specified stream, using the specified byte order mark detection option.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Sub New ( _ stream As Stream, _ detectEncodingFromByteOrderMarks As Boolean _ )
Parameters
- stream
- Type: System.IO.Stream
The stream to be read.
- detectEncodingFromByteOrderMarks
- Type: System.Boolean
true to look for byte order marks at the beginning of the file; otherwise, false to use UTF8 encoding.
| Exception | Condition |
|---|---|
| ArgumentException | stream does not support reading. |
| ArgumentNullException | stream is Nothing. |
This constructor initializes the encoding to UTF8Encoding, the BaseStream property using the stream parameter, and the internal buffer to the default size.
The StreamReader object calls Stream.Dispose on the provided Stream object when StreamReader.Dispose is called.
If the detectEncodingFromByteOrderMarks parameter is true, the StreamReader 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. If the detectEncodingFromByteOrderMarks parameter is false, the StreamReader object automatically use UTF-8. See the Encoding.GetPreamble method for more information.