KGy SOFT JSON Libraries Help
Json
Tries to get the specified JsonValue as a String value if expectedType is Undefined
or matches the Type property of the specified json parameter.
Definition
Namespace: KGySoft.Json
Assembly: KGySoft.Json (in KGySoft.Json.dll) Version: 3.0.0
if the specified JsonValue could be converted; otherwise, .
Assembly: KGySoft.Json (in KGySoft.Json.dll) Version: 3.0.0
C#
public static bool TryGetString(
this JsonValue json,
out string value,
JsonValueType expectedType = JsonValueType.Undefined,
bool allowNullIfStringIsExpected = false
)VB
<ExtensionAttribute>
Public Shared Function TryGetString (
json As JsonValue,
<OutAttribute> ByRef value As String,
Optional expectedType As JsonValueType = JsonValueType.Undefined,
Optional allowNullIfStringIsExpected As Boolean = false
) As BooleanC++
public:
[ExtensionAttribute]
static bool TryGetString(
JsonValue json,
[OutAttribute] String^% value,
JsonValueType expectedType = JsonValueType::Undefined,
bool allowNullIfStringIsExpected = false
)F#
[<ExtensionAttribute>]
static member TryGetString :
json : JsonValue *
value : string byref *
?expectedType : JsonValueType *
?allowNullIfStringIsExpected : bool
(* Defaults:
let _expectedType = defaultArg expectedType JsonValueType.Undefined
let _allowNullIfStringIsExpected = defaultArg allowNullIfStringIsExpected false
*)
-> bool Parameters
- json JsonValue
- The JsonValue to be converted to String.
- value String
- When this method returns, the result of the conversion, if json could be converted; otherwise, . This parameter is passed uninitialized.
- expectedType JsonValueType (Optional)
- The expected Type of the specified json parameter,
or Undefined to allow any type. This parameter is optional.
Default value: Undefined. - allowNullIfStringIsExpected Boolean (Optional)
- to return if expectedType is String
but the actual Type is Null; otherwise, . This parameter is optional.
Default value: .
Return Value
Booleanif the specified JsonValue could be converted; otherwise, .