Skip to content

Improved documentation for MemoryFailPoint when the constructor is called with value 0 #9544

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
merged 1 commit into from
May 15, 2024
Merged

Improved documentation for MemoryFailPoint when the constructor is called with value 0 #9544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions xml/System.Runtime/MemoryFailPoint.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@

To use a memory gate, you must create a <xref:System.Runtime.MemoryFailPoint> object and specify the number of megabytes (MB) of memory that the next operation is expected to use. If enough memory is not available, an <xref:System.InsufficientMemoryException> exception is thrown.

The parameter of the constructor must be a positive integer. A negative value raises an <xref:System.ArgumentOutOfRangeException> exception.
The parameter of the constructor must be a positive integer. A negative value or 0 raises an <xref:System.ArgumentOutOfRangeException> exception.

<xref:System.Runtime.MemoryFailPoint> operates at a granularity of 16 MB. Any values smaller than 16 MB are treated as 16 MB, and other values are treated as the next largest multiple of 16 MB.

Expand Down Expand Up @@ -133,7 +133,7 @@

]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The specified memory size is negative.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The specified memory size is negative or 0.</exception>
<exception cref="T:System.InsufficientMemoryException">There is insufficient memory to begin execution of the code protected by the gate.</exception>
</Docs>
</Member>
Expand Down
Loading