Edit

Share via

JsonElement.TryGetDateTimeOffset(DateTimeOffset) Method

  • Reference

Definition

Namespace:
System.Text.Json
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v10.0.0-preview.1.25080.5
Source:
JsonElement.cs
Source:
JsonElement.cs
Source:
JsonElement.cs
Source:
JsonElement.cs
Source:
JsonElement.cs
Source:
JsonElement.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.

Attempts to represent the current JSON string as a DateTimeOffset.

C# 
public bool TryGetDateTimeOffset(out DateTimeOffset value);

Parameters

value
DateTimeOffset

When this method returns, contains the date and time value equivalent to the current JSON string if the conversion succeeded, or MinValue if the conversion failed.

Returns

Boolean

true if the string can be represented as a DateTimeOffset; otherwise, false.

Exceptions

InvalidOperationException

This value's ValueKind is not String.

ObjectDisposedException

The parent JsonDocument has been disposed.

Remarks

This method only creates a DateTimeOffset representation of JSON strings that conform to the ISO 8601-1 extended format (see DateTime and DateTimeOffset support in System.Text.Json).

Applies to

Product Versions
.NET Core 3.0, Core 3.1, 5, 6, 7, 8 (package-provided), 8, 9 (package-provided), 9, 10 (package-provided), 10
.NET Standard 2.0 (package-provided)