Skip to content

Correct FileStream(FileOptions) docs for bufferSize = 0 behavior #13062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 5 commits into
base: main
Choose a base branch
from
+6 −2
Open

Correct FileStream(FileOptions) docs for bufferSize = 0 behavior #13062

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
de0a765
Initial plan
Copilot Sep 10, 2026
240efd2
Fix FileStream bufferSize docs for FileOptions ctor
Copilot Sep 10, 2026
cc63e7a
Clarify FileStream bufferSize=0 version behavior
Copilot Sep 10, 2026
5abebd3
Clarify bufferSize=1 disables FileStream buffering
Copilot Sep 10, 2026
c8ca2fc
Update bufferSize parameter documentation
adamsitnik Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions xml/System.IO/FileStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1218,7 +1218,7 @@ The file was too large (when <see cref="P:System.IO.FileStreamOptions.Preallocat
<param name="mode">One of the enumeration values that determines how to open or create the file.</param>
<param name="access">A bitwise combination of the enumeration values that determines how the file can be accessed by the <see langword="FileStream" /> object. This also determines the values returned by the <see cref="P:System.IO.FileStream.CanRead" /> and <see cref="P:System.IO.FileStream.CanWrite" /> properties of the <see langword="FileStream" /> object. <see cref="P:System.IO.FileStream.CanSeek" /> is <see langword="true" /> if <paramref name="path" /> specifies a disk file.</param>
<param name="share">A bitwise combination of the enumeration values that determines how the file will be shared by processes.</param>
<param name="bufferSize">A positive <see cref="T:System.Int32" /> value greater than 0 indicating the buffer size. The default buffer size is 4096.</param>
<param name="bufferSize">A non-negative <see cref="T:System.Int32" /> value indicating the buffer size. The default buffer size is 4096. In versions earlier than .NET 6, this value must be greater than 0. In .NET 6 and later versions, a value of 0 disables buffering (a value of 1 disables buffering in every version).</param>

@gewarren gewarren Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We actually removed all comments for out of support versions. When you say versions earlier than .NET 6, does that apply to .NET Framework as well? If so, let's put that info in the dotnetfw-api-docs repo instead and just state the [.NET 6+] behavior here without a version.

<param name="options">A bitwise combination of the enumeration values that specifies additional file options.</param>
<summary>Initializes a new instance of the <see cref="T:System.IO.FileStream" /> class with the specified path, creation mode, read/write and sharing permission, the access other FileStreams can have to the same file, the buffer size, and additional file options.</summary>
<remarks>
Expand Down Expand Up @@ -1258,7 +1258,11 @@ The file was too large (when <see cref="P:System.IO.FileStreamOptions.Preallocat
<exception cref="T:System.NotSupportedException">
<paramref name="path" /> refers to a non-file device, such as "con:", "com1:", or "lpt1:", in a non-NTFS environment.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="bufferSize" /> is negative or zero.
<paramref name="bufferSize" /> is negative.

-or-

<paramref name="bufferSize" /> is zero in versions earlier than .NET 6.
Comment thread
adamsitnik marked this conversation as resolved.

-or-

Expand Down
Loading