JsonElement.TryGetDouble(Double) Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

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

Source:

JsonElement.cs

Attempts to represent the current JSON number as a Double.

public:
 bool TryGetDouble([Runtime::InteropServices::Out] double % value);

public bool TryGetDouble (out double value);

member this.TryGetDouble : double -> bool

Public Function TryGetDouble (ByRef value As Double) As Boolean

Parameters

value

Double

When this method returns, contains a double-precision floating point value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed.

Returns

Boolean

true if the number can be represented as a Double; otherwise, false.

Exceptions

InvalidOperationException

This value's ValueKind is not Number.

ObjectDisposedException

The parent JsonDocument has been disposed.

Remarks

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

On .NET Core, this method does not return false for values larger than Double.MaxValue or smaller than Double.MinValue. Instead, it returns true and assigns Double.PositiveInfinity or Double.NegativeInfinity to value.