JsonElement.TryGetByte(Byte) 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 Byte.

public:
 bool TryGetByte([Runtime::InteropServices::Out] System::Byte % value);

public bool TryGetByte (out byte value);

member this.TryGetByte : byte -> bool

Public Function TryGetByte (ByRef value As Byte) As Boolean

Parameters

value

Byte

When this method returns, contains the byte equivalent of 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 Byte; 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.