JsonElement.TryGetUInt16(UInt16) Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Source:

JsonElement.cs

Important

This API is not CLS-compliant.

Attempts to represent the current JSON number as a UInt16.

public:
 bool TryGetUInt16([Runtime::InteropServices::Out] System::UInt16 % value);

[System.CLSCompliant(false)]
public bool TryGetUInt16 (out ushort value);

[<System.CLSCompliant(false)>]
member this.TryGetUInt16 : uint16 -> bool

Public Function TryGetUInt16 (ByRef value As UShort) As Boolean

Parameters

value

UInt16

When this method returns, contains the unsigned 16-bit integer value 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 UInt16; otherwise, false.

Attributes

CLSCompliantAttribute

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.