Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Utf8JsonReader.GetString Method

Definition

Namespace:
System.Text.Json
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v11.0.0-preview.5.26302.115
Source:
Utf8JsonReader.TryGet.cs
Source:
Utf8JsonReader.TryGet.cs
Source:
Utf8JsonReader.TryGet.cs
Source:
Utf8JsonReader.TryGet.cs
Source:
Utf8JsonReader.TryGet.cs
Source:
Utf8JsonReader.TryGet.cs
Source:
Utf8JsonReader.TryGet.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 System::String ^ GetString();
public string? GetString();
public string GetString();
member this.GetString : unit -> string
Public Function GetString () As String

Returns

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

Exceptions

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


Feedback

Was this page helpful?