JsonSerializerOptions.MaxDepth Property

Reference

Definition

Namespace:: System.Text.Json

Assembly:: System.Text.Json.dll

Package:: System.Text.Json v10.0.0-preview.1.25080.5

Source:: JsonSerializerOptions.cs

Source:: JsonSerializerOptions.cs

Source:: JsonSerializerOptions.cs

Source:: JsonSerializerOptions.cs

Source:: JsonSerializerOptions.cs

Source:: JsonSerializerOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the maximum depth allowed when serializing or deserializing JSON, with the default value of 0 indicating a maximum depth of 64.

public:
 property int MaxDepth { int get(); void set(int value); };

public int MaxDepth { get; set; }

member this.MaxDepth : int with get, set

Public Property MaxDepth As Integer

Property Value

Int32

The maximum depth allowed when serializing or deserializing JSON.

Exceptions

InvalidOperationException

This property was set after serialization or deserialization has occurred.

ArgumentOutOfRangeException

The max depth is set to a negative value.

Remarks

Going past this depth throws a JsonException.

Applies to

Product	Versions
.NET	Core 3.0, Core 3.1, 5, 6, 7, 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10
.NET Standard	2.0 (package-provided)

Share via