bson_array_as_json man page

bson_array_as_json — bson_array_as_json()

Synopsis

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

Parameters

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 JSON array, rather then JSON document. 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.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

Info

Nov 20, 2017 1.8.2 Libbson