JsonValueExtensionsTryGetString Method

Tries to get the specified JsonValue as a String value if expectedType is Undefined or matches the Type property of the specified json parameter.


Namespace: KGySoft.Json
Assembly: KGySoft.Json (in KGySoft.Json.dll) Version: 3.0.0
public static bool TryGetString(
	this JsonValue json,
	out string value,
	JsonValueType expectedType = JsonValueType.Undefined,
	bool allowNullIfStringIsExpected = false


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

if the specified JsonValue could be converted; otherwise, .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type JsonValue. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

See Also