:man_page: bson_as_canonical_extended_json bson_as_canonical_extended_json() ================================= Synopsis -------- .. code-block:: c char * bson_as_canonical_extended_json (const bson_t *bson, size_t *length); Parameters ---------- * ``bson``: A :symbol:`bson_t`. * ``length``: An optional location for the length of the resulting string. Description ----------- :symbol:`bson_as_canonical_extended_json()` encodes ``bson`` as a UTF-8 string in the Canonical Extended JSON. See `MongoDB Extended JSON format`_ for a description of Extended JSON formats. The caller is responsible for freeing the resulting UTF-8 encoded string by calling :symbol:`bson_free()` with the result. If non-NULL, ``length`` will be set to the length of the result in bytes. Returns ------- If successful, a newly allocated UTF-8 encoded string and ``length`` is set. Upon failure, NULL is returned. Example ------- .. literalinclude:: ../examples/extended-json.c :language: c :start-after: // bson_as_canonical_extended_json ... begin :end-before: // bson_as_canonical_extended_json ... end :dedent: 6 .. only:: html .. include:: includes/seealso/bson-as-json.txt .. _MongoDB Extended JSON format: https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md