JsonReaderOptions.CommentHandling Property

  • Reference

Definition

Namespace:
System.Text.Json
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v8.0.5
Package:
System.Text.Json v9.0.0-rc.2.24473.5
Source:
JsonReaderOptions.cs
Source:
JsonReaderOptions.cs
Source:
JsonReaderOptions.cs

Gets or sets a value that determines how the Utf8JsonReader handles comments when reading through the JSON data.

public:
 property System::Text::Json::JsonCommentHandling CommentHandling { System::Text::Json::JsonCommentHandling get(); void set(System::Text::Json::JsonCommentHandling value); };
public System.Text.Json.JsonCommentHandling CommentHandling { get; set; }
member this.CommentHandling : System.Text.Json.JsonCommentHandling with get, set
Public Property CommentHandling As JsonCommentHandling

Property Value

JsonCommentHandling

One of the enumeration values that indicates how comments are handled.

Exceptions

ArgumentOutOfRangeException

The property is being set to a value that is not a member of the JsonCommentHandling enumeration.

Remarks

By default, the reader throws a JsonException if it encounters a comment.

Applies to