Utf8JsonWriter.WriteCommentValue Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-rc.2.24473.5

Overloads

WriteCommentValue(ReadOnlySpan<Byte>)	Writes a UTF-8 text value as a JSON comment.
WriteCommentValue(ReadOnlySpan<Char>)	Writes a UTF-16 text value as a JSON comment.
WriteCommentValue(String)	Writes a string text value as a JSON comment.

WriteCommentValue(ReadOnlySpan<Byte>)

Source:

Utf8JsonWriter.WriteValues.Comment.cs

Writes a UTF-8 text value as a JSON comment.

public:
 void WriteCommentValue(ReadOnlySpan<System::Byte> utf8Value);

public void WriteCommentValue (ReadOnlySpan<byte> utf8Value);

member this.WriteCommentValue : ReadOnlySpan<byte> -> unit

Public Sub WriteCommentValue (utf8Value As ReadOnlySpan(Of Byte))

Parameters

utf8Value

ReadOnlySpan<Byte>

The UTF-8 encoded value to be written as a JSON comment within /../.

Exceptions

ArgumentException

The specified value is too large.

-or-

utf8Value contains a comment delimiter (that is, */).

Remarks

The comment value is not escaped before writing.

WriteCommentValue(ReadOnlySpan<Char>)

Source:

Utf8JsonWriter.WriteValues.Comment.cs

Writes a UTF-16 text value as a JSON comment.

public:
 void WriteCommentValue(ReadOnlySpan<char> value);

public void WriteCommentValue (ReadOnlySpan<char> value);

member this.WriteCommentValue : ReadOnlySpan<char> -> unit

Public Sub WriteCommentValue (value As ReadOnlySpan(Of Char))

Parameters

value

ReadOnlySpan<Char>

The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /../.

Exceptions

ArgumentException

The specified value is too large.

-or-

value contains a comment delimiter (that is, */).

Remarks

The comment value is not escaped before writing.

WriteCommentValue(String)

Source:

Utf8JsonWriter.WriteValues.Comment.cs

Writes a string text value as a JSON comment.

public:
 void WriteCommentValue(System::String ^ value);

public void WriteCommentValue (string value);

member this.WriteCommentValue : string -> unit

Public Sub WriteCommentValue (value As String)

Parameters

value

String

The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /../.

Exceptions

ArgumentException

The specified value is too large.

-or-

value contains a comment delimiter (that is, */).

ArgumentNullException

The value parameter is null.

Remarks

The comment value is not escaped before writing.