Skip to content

Clarify that the array passed to ByteArrayContent should not be modified. #8484

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

Merged
rzikm merged 2 commits into from
Oct 10, 2022
Merged

Clarify that the array passed to ByteArrayContent should not be modified. #8484

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8b65cf
Clarify that the array passed to ByteArrayContent should not be modif…
rzikm Oct 10, 2022
2183db0
Update xml/System.Net.Http/ByteArrayContent.xml
rzikm Oct 10, 2022
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
13 changes: 11 additions & 2 deletions xml/System.Net.Http/ByteArrayContent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,14 @@
<Docs>
<param name="content">The content used to initialize the <see cref="T:System.Net.Http.ByteArrayContent" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.ByteArrayContent" /> class.</summary>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Net.Http.ByteArrayContent> class does not internally copy the provided byte array but keeps a reference to it instead. Callers should not modify the data in the array until the content is sent.
Copy link
Member

@stephentoub stephentoub Oct 10, 2022

Choose a reason for hiding this comment

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

until the content is sent

"until after the content is sent"

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="content" /> parameter is <see langword="null" />.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -122,7 +129,9 @@
<format type="text/markdown"><![CDATA[
## Remarks
Only the range specified by the `offset` parameter and the `count` parameter is used as content. Syntax
The <xref:System.Net.Http.ByteArrayContent> class does not internally copy the provided byte array but keeps a reference to it instead. Callers should not modify the data in the array until the content is sent.
Only the range specified by the `offset` parameter and the `count` parameter is used as content.
]]></format>
</remarks>
Expand Down