JsonValue.TryGetValue<T>(T) Method

Definition

Tries to obtain the current JSON value and returns a value that indicates whether the operation succeeded.

public abstract bool TryGetValue<T> (out T? value);

Type Parameters

T

The type of value to obtain.

Parameters

value
T

When this method returns, contains the parsed value.

Returns

true if the value can be successfully obtained; otherwise, false.

Remarks

{T} can be the type or base type of the underlying value. If the underlying value is a JsonElement, then {T} can also be the type of any primitive value supported by current JsonElement.

Specifying the Object type for {T} will always succeed and return the underlying value as Object.

The underlying value of a JsonValue after deserialization is an instance of JsonElement, otherwise it's the value specified when the JsonValue was created.

Applies to

Product Versions
.NET 6, 7, 8 (package-provided), 8, 9 (package-provided), 9
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)