Scroll to navigation

BSON_ARRAY_AS_JSON(3) libbson BSON_ARRAY_AS_JSON(3)

SYNOPSIS

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


PARAMETERS

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

DESCRIPTION

The bson_array_as_json() function shall encode bson as a UTF-8 string using libbson's legacy JSON format, except the outermost element is encoded as a JSON array, rather than a JSON document. This function is superseded by bson_array_as_canonical_extended_json() and bson_array_as_relaxed_extended_json(), which use the same MongoDB Extended JSON format as all other MongoDB drivers. 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.

RETURNS

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

Upon failure, NULL is returned.

EXAMPLE

#include <bson/bson.h>
int main ()
{

bson_t bson;
char *str;
bson_init (&bson);
/* BSON array is a normal BSON document with integer values for the keys,
* starting with 0 and continuing sequentially
*/
BSON_APPEND_UTF8 (&bson, "0", "foo");
BSON_APPEND_UTF8 (&bson, "1", "bar");
str = bson_array_as_json (&bson, NULL);
/* Prints
* [ "foo", "bar" ]
*/
printf ("%s\n", str);
bson_free (str);
bson_destroy (&bson); }


AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

February 25, 2024 1.26.0