JsonElement.TryGetSingle(Single) 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 Single.

public:
 bool TryGetSingle([Runtime::InteropServices::Out] float % value);

public bool TryGetSingle (out float value);

member this.TryGetSingle : single -> bool

Public Function TryGetSingle (ByRef value As Single) As Boolean

Parameters

value

Single

When this method returns, contains the single-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 Single; 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 Single.MaxValue or smaller than Single.MinValue). Instead, it returns true and assigns Single.PositiveInfinity or Single.NegativeInfinity to the value argument.