DOKK / manpages / debian 13 / libbson-doc / bson_as_canonical_extended_json.3.en
BSON_AS_CANONICAL_EXTENDED_JSON(3) libbson BSON_AS_CANONICAL_EXTENDED_JSON(3)

char *
bson_as_canonical_extended_json (const bson_t *bson, size_t *length);


  • bson: A bson_t.
  • length: An optional location for the length of the resulting string.

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 bson_free() with the result.

If non-NULL, length will be set to the length of the result in bytes.

If successful, a newly allocated UTF-8 encoded string and length is set.

Upon failure, NULL is returned.

bson_t *b = BCON_NEW ("foo", BCON_INT32 (123));
char *str = bson_as_canonical_extended_json (b, NULL);
printf ("Canonical Extended JSON: %s\n", str);
// Prints:
// Canonical Extended JSON: { "foo" : { "$numberInt" : "123" } }
bson_free (str);
bson_destroy (b);


MongoDB, Inc

2009-present, MongoDB, Inc.

May 7, 2025 1.30.4