JsonElement.GetBoolean Method

Reference

Definition

Namespace:: System.Text.Json

Assembly:: System.Text.Json.dll

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

Source:: JsonElement.cs

Source:: JsonElement.cs

Source:: JsonElement.cs

Source:: JsonElement.cs

Source:: JsonElement.cs

Source:: JsonElement.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 the value of the element as a Boolean.

public:
 bool GetBoolean();

public bool GetBoolean();

member this.GetBoolean : unit -> bool

Public Function GetBoolean () As Boolean

Returns

Boolean

The value of the element as a Boolean.

Exceptions

InvalidOperationException

This value's ValueKind is neither True nor False.

ObjectDisposedException

The parent JsonDocument has been disposed.

Remarks

This method does not parse the contents of a JSON string value.

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