JsonElement.TryGetBytesFromBase64(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 string as a byte array, assuming that it is Base64 encoded.

public:
 bool TryGetBytesFromBase64([Runtime::InteropServices::Out] cli::array <System::Byte> ^ % value);

public bool TryGetBytesFromBase64 (out byte[]? value);

member this.TryGetBytesFromBase64 : Byte[] -> bool

Public Function TryGetBytesFromBase64 (ByRef value As Byte()) As Boolean

Parameters

value

Byte[]

If the method succeeds, contains the decoded binary representation of the Base64 text.

Returns

Boolean

true if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, false.

Exceptions

InvalidOperationException

This value's ValueKind is not String.

ObjectDisposedException

The parent JsonDocument has been disposed.

Remarks

This method does not create a byte array representation of values other than Base64 encoded JSON strings.