Utf8JsonReader.GetString Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Source:

Utf8JsonReader.TryGet.cs

Reads the next JSON token value from the source unescaped and transcodes it as a string.

C#

public string? GetString();

Returns

String

The token value parsed to a string, or null if TokenType is Null.

Exceptions

InvalidOperationException

The JSON token value isn't a string (that is, not a String, PropertyName, or Null).

-or-

The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates.

Remarks

Returns null when TokenType is JsonTokenType.Null.

If you're using .NET 7 or a later version and performance is a concern, consider using the Utf8JsonReader.CopyString method instead. CopyString avoids allocating a new string each time the method is called.

Applies to

See also

• TokenType