JsonValue.TryGetValue<T>(T) Method

Definition

Namespace:

System.Text.Json.Nodes

Assembly:

System.Text.Json.dll

Package:

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

Source:

JsonValue.cs

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

public:
generic <typename T>
 abstract bool TryGetValue([Runtime::InteropServices::Out] T % value);

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

abstract member TryGetValue : 'T -> bool

Public MustOverride Function TryGetValue(Of T) (ByRef value As T) As Boolean

Type Parameters

T

The type of value to obtain.

Parameters

value

T

When this method returns, contains the parsed value.

Returns

Boolean

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.