KGy SOFT JSON Libraries Help
Json
Gets the specified JsonValue as a DateTime value using the specified format if expectedType
is Undefined or matches the Type property of the specified json parameter and it can be
converted to DateTime; otherwise, returns defaultValue.
Definition
Namespace: KGySoft.Json
Assembly: KGySoft.Json (in KGySoft.Json.dll) Version: 3.0.0
A DateTime value if json could be converted; otherwise, defaultValue.
Assembly: KGySoft.Json (in KGySoft.Json.dll) Version: 3.0.0
C#
public static DateTime GetDateTimeOrDefault(
this JsonValue json,
JsonDateTimeFormat format,
DateTime defaultValue = default,
DateTimeKind? desiredKind = null,
JsonValueType expectedType = JsonValueType.Undefined
)VB
<ExtensionAttribute>
Public Shared Function GetDateTimeOrDefault (
json As JsonValue,
format As JsonDateTimeFormat,
Optional defaultValue As DateTime = Nothing,
Optional desiredKind As DateTimeKind? = Nothing,
Optional expectedType As JsonValueType = JsonValueType.Undefined
) As DateTimeC++
public:
[ExtensionAttribute]
static DateTime GetDateTimeOrDefault(
JsonValue json,
JsonDateTimeFormat format,
DateTime defaultValue = DateTime(),
Nullable<DateTimeKind> desiredKind = nullptr,
JsonValueType expectedType = JsonValueType::Undefined
)F#
[<ExtensionAttribute>]
static member GetDateTimeOrDefault :
json : JsonValue *
format : JsonDateTimeFormat *
?defaultValue : DateTime *
?desiredKind : Nullable<DateTimeKind> *
?expectedType : JsonValueType
(* Defaults:
let _defaultValue = defaultArg defaultValue new DateTime()
let _desiredKind = defaultArg desiredKind null
let _expectedType = defaultArg expectedType JsonValueType.Undefined
*)
-> DateTime Parameters
- json JsonValue
- The JsonValue to be converted to DateTime.
- format JsonDateTimeFormat
- A JsonDateTimeFormat value that specifies the format of the date-time value in the JsonValue.
- defaultValue DateTime (Optional)
- The value to be returned if the conversion fails. This parameter is optional.
Default value: MinValue. - desiredKind NullableDateTimeKind (Optional)
- The desired value of the Kind property of the returned DateTime instance,
or to preserve the one that could be retrieved from the JsonValue.
Converting between Utc and Local affects the actual time value,
while changing to or from Unspecified just changes the Kind property without converting the value. This parameter is optional.
Default value: . - expectedType JsonValueType (Optional)
- The expected Type of the specified json parameter,
or Undefined to allow any type. This parameter is optional.
Default value: Undefined.
Return Value
DateTimeA DateTime value if json could be converted; otherwise, defaultValue.