GLib-2.0 ▶ GLib ▶ variant_parse

Parses a GLib.Variant from a text representation.

A single GLib.Variant is parsed from the content of text.

The format is described here.

The memory at limit will never be accessed and the parser behaves as if the character at limit is the nul terminator. This has the effect of bounding text.

If endptr is non-null then text is permitted to contain data following the value that this function parses and endptr will be updated to point to the first character past the end of the text parsed by this function. If endptr is null and there is extra data then an error is returned.

If type is non-null then the value will be parsed to have that type. This may result in additional parse errors (in the case that the parsed value doesn't fit the type) but may also result in fewer errors (in the case that the type would have been ambiguous, such as with empty arrays).

In the event that the parsing is successful, the resulting GLib.Variant is returned. It is never floating, and must be freed with GLib.Variant.unref.

In case of any error, null will be returned. If error is non-null then it will be set to reflect the error that occurred.

Officially, the language understood by the parser is “any string produced by GLib.Variant.print”. This explicitly includes g_variant_print()’s annotated types like int64 -1000.

There may be implementation specific restrictions on deeply nested values, which would result in a GLib.VariantParseError.RECURSION error. GLib.Variant is guaranteed to handle nesting up to at least 64 levels.