Skip to content

Commit eb7a15f

Browse files
lauxjpnmairaw
authored andcommitted
Fix issue #3122. (#3123)
* Fix issue #3122. * Correct max. bytes limit. Co-Authored-By: Ahson Khan <[email protected]> * Correct max. bytes limit. Add remark about bytes encoding. * Apply guidelines for wording, units and measurement. Co-Authored-By: Maira Wenzel <[email protected]> * Apply guidelines for wording, units and measurement. Co-Authored-By: Maira Wenzel <[email protected]> * Apply guidelines for wording, units and measurement. Co-Authored-By: Maira Wenzel <[email protected]> * Apply guidelines for wording, units and measurement. Co-Authored-By: Maira Wenzel <[email protected]> * Apply guidelines for wording, units and measurement. Co-Authored-By: Maira Wenzel <[email protected]> * Combine separate remarks sentences.
1 parent 3e35e97 commit eb7a15f

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

xml/System.Text.Json/Utf8JsonWriter.xml

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -455,11 +455,13 @@ The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original wri
455455
456456
## Remarks
457457
458-
The property name is escaped before writing.
458+
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
459+
460+
The property name is escaped and the bytes are encoded before writing.
459461
460462
]]></format>
461463
</remarks>
462-
<exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
464+
<exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
463465
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
464466
</Docs>
465467
</Member>
@@ -491,11 +493,13 @@ The property name is escaped before writing.
491493
492494
## Remarks
493495
494-
The property name is escaped before writing.
496+
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
497+
498+
The property name is escaped and the bytes are encoded before writing.
495499
496500
]]></format>
497501
</remarks>
498-
<exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
502+
<exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
499503
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
500504
</Docs>
501505
</Member>
@@ -527,11 +531,13 @@ The property name is escaped before writing.
527531
528532
## Remarks
529533
530-
The property name is escaped before writing.
534+
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
535+
536+
The property name is escaped and the bytes are encoded before writing.
531537
532538
]]></format>
533539
</remarks>
534-
<exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
540+
<exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
535541
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
536542
<exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
537543
</Docs>
@@ -564,10 +570,15 @@ The property name is escaped before writing.
564570
565571
## Remarks
566572
573+
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
574+
567575
The property name should already be escaped when the instance of <xref:System.Text.Json.JsonEncodedText> was created.
568576
577+
The bytes are encoded before writing.
578+
569579
]]></format>
570580
</remarks>
581+
<exception cref="T:System.ArgumentException">The specified value is too large.</exception>
571582
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
572583
</Docs>
573584
</Member>
@@ -597,6 +608,8 @@ The property name should already be escaped when the instance of <xref:System.Te
597608
598609
## Remarks
599610
611+
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
612+
600613
The bytes are encoded before writing.
601614
602615
]]></format>

0 commit comments

Comments
 (0)