forked from mongodb/libbson
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bson_as_json.page
52 lines (46 loc) · 1.76 KB
/
bson_as_json.page
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<?xml version="1.0"?>
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
style="function"
xmlns:api="http://projectmallard.org/experimental/api/"
xmlns:ui="http://projectmallard.org/experimental/ui/"
id="bson_as_json">
<info>
<link type="guide" xref="bson_t" group="function"/>
</info>
<title>bson_as_json()</title>
<section id="synopsis">
<title>Synopsis</title>
<synopsis><code mime="text/x-csrc"><![CDATA[char *
bson_as_json (const bson_t *bson,
size_t *length);
]]></code></synopsis>
</section>
<section id="parameters">
<title>Parameters</title>
<table>
<tr><td><p>bson</p></td><td><p>A <code xref="bson_t">bson_t</code>.</p></td></tr>
<tr><td><p>length</p></td><td><p>An optional location for the length of the resulting string.</p></td></tr>
</table>
</section>
<section id="description">
<title>Description</title>
<p>The <code xref="bson_as_json">bson_as_json()</code> function shall encode <code>bson</code> as a JSON encoded UTF-8 string.</p>
<p>The caller is responsible for freeing the resulting UTF-8 encoded string by calling <code xref="bson_free">bson_free()</code> with the result.</p>
<p>If non-NULL, <code>length</code> will be set to the length of the result in bytes.</p>
</section>
<section id="return">
<title>Returns</title>
<p>If successful, a newly allocated UTF-8 encoded string and <code>length</code> is set.</p>
<p>Upon failure, NULL is returned.</p>
</section>
<section id="example">
<title>Example</title>
<listing>
<title>bson_as_json</title>
<code mime="text/x-csrc"><![CDATA[char *str = bson_as_json (doc, NULL);
printf ("%s\n", str);
bson_free (str);]]></code>
</listing>
</section>
</page>