1BSON_ARRAY_AS_JSON(3)               libbson              BSON_ARRAY_AS_JSON(3)
2
3
4

NAME

6       bson_array_as_json - bson_array_as_json()
7

SYNOPSIS

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

PARAMETERS

13       • bson: A bson_t.
14
15       • length: An optional location for the length of the resulting string.
16

DESCRIPTION

18       The  bson_array_as_json()  function shall encode bson as a UTF-8 string
19       using libbson's legacy JSON format, except the outermost element is en‐
20       coded  as a JSON array, rather than a JSON document.  The caller is re‐
21       sponsible for freeing the resulting UTF-8  encoded  string  by  calling
22       bson_free() with the result.
23
24       If non-NULL, length will be set to the length of the result in bytes.
25

RETURNS

27       If  successful,  a  newly  allocated UTF-8 encoded string and length is
28       set.
29
30       Upon failure, NULL is returned.
31

EXAMPLE

33          #include <bson/bson.h>
34
35          int main ()
36          {
37             bson_t bson;
38             char *str;
39
40             bson_init (&bson);
41             /* BSON array is a normal BSON document with integer values for the keys,
42              * starting with 0 and continuing sequentially
43              */
44             BSON_APPEND_UTF8 (&bson, "0", "foo");
45             BSON_APPEND_UTF8 (&bson, "1", "bar");
46
47             str = bson_array_as_json (&bson, NULL);
48             /* Prints
49              * [ "foo", "bar" ]
50              */
51             printf ("%s\n", str);
52             bson_free (str);
53
54             bson_destroy (&bson);
55          }
56

AUTHOR

58       MongoDB, Inc
59

61       2017-present, MongoDB, Inc
62
63
64
65
661.20.0                           Nov 18, 2021            BSON_ARRAY_AS_JSON(3)
Impressum