|
974 | 974 | <param name="stream">The stream to be read.</param>
|
975 | 975 | <param name="encoding">The character encoding to use.</param>
|
976 | 976 | <param name="detectEncodingFromByteOrderMarks">Indicates whether to look for byte order marks at the beginning of the file.</param>
|
977 |
| - <param name="bufferSize">The minimum buffer size.</param> |
| 977 | + <param name="bufferSize">The minimum buffer size in bytes.</param> |
978 | 978 | <summary>Initializes a new instance of the <see cref="T:System.IO.StreamReader" /> class for the specified stream, with the specified character encoding, byte order mark detection option, and buffer size.</summary>
|
979 | 979 | <remarks>
|
980 | 980 | <format type="text/markdown"><![CDATA[
|
981 | 981 |
|
982 | 982 | ## Remarks
|
983 |
| - The buffer size, in number of 16-bit characters, is set by the `bufferSize` parameter. If `bufferSize` is less than the minimum allowable size (128 characters), the minimum allowable size is used. |
| 983 | + The buffer size, in bytes, is set by the `bufferSize` parameter. If `bufferSize` is less than the minimum allowable size (128 bytes), the minimum allowable size is used. |
984 | 984 |
|
985 | 985 | This constructor allows you to change the encoding the first time you read from the <xref:System.IO.StreamReader> object. The `detectEncodingFromByteOrderMarks` parameter detects the encoding by looking at the first four bytes of the stream. It automatically recognizes UTF-8, little-endian UTF-16, big-endian UTF-16, little-endian UTF-32, and big-endian UTF-32 text if the file starts with the appropriate byte order marks. Otherwise, the user-provided encoding is used. See the <xref:System.Text.Encoding.GetPreamble%2A?displayProperty=nameWithType> method for more information.
|
986 | 986 |
|
|
1077 | 1077 | <param name="path">The complete file path to be read.</param>
|
1078 | 1078 | <param name="encoding">The character encoding to use.</param>
|
1079 | 1079 | <param name="detectEncodingFromByteOrderMarks">Indicates whether to look for byte order marks at the beginning of the file.</param>
|
1080 |
| - <param name="bufferSize">The minimum buffer size, in number of 16-bit characters.</param> |
| 1080 | + <param name="bufferSize">The minimum buffer size in bytes.</param> |
1081 | 1081 | <summary>Initializes a new instance of the <see cref="T:System.IO.StreamReader" /> class for the specified file name, with the specified character encoding, byte order mark detection option, and buffer size.</summary>
|
1082 | 1082 | <remarks>
|
1083 | 1083 | <format type="text/markdown"><![CDATA[
|
|
1087 | 1087 |
|
1088 | 1088 | This constructor allows you to change the encoding the first time you read from the <xref:System.IO.StreamReader> object. The `detectEncodingFromByteOrderMarks` parameter detects the encoding by looking at the first four bytes of the stream. It automatically recognizes UTF-8, little-endian UTF-16, big-endian UTF-16, little-endian UTF-32, and big-endian UTF-32 text if the file starts with the appropriate byte order marks. Otherwise, the user-provided encoding is used. See the <xref:System.Text.Encoding.GetPreamble%2A?displayProperty=nameWithType> method for more information.
|
1089 | 1089 |
|
1090 |
| - The buffer size, in number of 16-bit characters, is set by the `bufferSize` parameter. If `bufferSize` is less than the minimum allowable size (128 characters), the minimum allowable size is used. |
| 1090 | + The buffer size, in bytes, is set by the `bufferSize` parameter. If `bufferSize` is less than the minimum allowable size (128 bytes), the minimum allowable size is used. |
1091 | 1091 |
|
1092 | 1092 | The `path` parameter can be a file name, including a file on a Universal Naming Convention (UNC) share.
|
1093 | 1093 |
|
|
1249 | 1249 | <param name="encoding">The character encoding to use.</param>
|
1250 | 1250 | <param name="detectEncodingFromByteOrderMarks">
|
1251 | 1251 | <see langword="true" /> to look for byte order marks at the beginning of the file; otherwise, <see langword="false" />.</param>
|
1252 |
| - <param name="bufferSize">The minimum buffer size.</param> |
| 1252 | + <param name="bufferSize">The minimum buffer size in bytes.</param> |
1253 | 1253 | <param name="leaveOpen">
|
1254 | 1254 | <see langword="true" /> to leave the stream open after the <see cref="T:System.IO.StreamReader" /> object is disposed; otherwise, <see langword="false" />.</param>
|
1255 | 1255 | <summary>Initializes a new instance of the <see cref="T:System.IO.StreamReader" /> class for the specified stream based on the specified character encoding, byte order mark detection option, and buffer size, and optionally leaves the stream open.</summary>
|
|
1259 | 1259 | ## Remarks
|
1260 | 1260 | Unless you set the `leaveOpen` parameter to `true`, the <xref:System.IO.StreamReader> object calls <xref:System.IO.Stream.Dispose> on the provided <xref:System.IO.Stream> object when <xref:System.IO.StreamReader.Dispose%2A?displayProperty=nameWithType> is called.
|
1261 | 1261 |
|
1262 |
| - The buffer size, in number of 16-bit characters, is set by the `bufferSize` parameter. If `bufferSize` is less than the minimum allowable size (128 characters), the minimum allowable size is used. |
| 1262 | + The buffer size, in bytes, is set by the `bufferSize` parameter. If `bufferSize` is less than the minimum allowable size (128 bytes), the minimum allowable size is used. |
1263 | 1263 |
|
1264 | 1264 | This constructor enables you to change the encoding the first time you read from the <xref:System.IO.StreamReader> object. If the `detectEncodingFromByteOrderMarks` parameter is `true`, the constructor detects the encoding by looking at the first four bytes of the stream. It automatically recognizes UTF-8, little-endian UTF-16, big-endian UTF-16, little-endian UTF-32, and big-endian UTF-32 text if the file starts with the appropriate byte order marks. Otherwise, the user-provided encoding is used. See the <xref:System.Text.Encoding.GetPreamble%2A?displayProperty=nameWithType> method for more information.
|
1265 | 1265 |
|
|
0 commit comments