JsonElement.TryGetDateTimeOffset(DateTimeOffset) Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-preview.3.24172.9

Source:

JsonElement.cs

Attempts to represent the current JSON string as a DateTimeOffset.

public:
 bool TryGetDateTimeOffset([Runtime::InteropServices::Out] DateTimeOffset % value);

public bool TryGetDateTimeOffset (out DateTimeOffset value);

member this.TryGetDateTimeOffset : DateTimeOffset -> bool

Public Function TryGetDateTimeOffset (ByRef value As DateTimeOffset) As Boolean

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).