forked from mongodb/libbson
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bson_append_minkey.page
40 lines (36 loc) · 1.56 KB
/
bson_append_minkey.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
<?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_append_minkey">
<info>
<link type="guide" xref="bson_t" group="function"/>
</info>
<title>bson_append_minkey()</title>
<section id="synopsis">
<title>Synopsis</title>
<synopsis><code mime="text/x-csrc"><![CDATA[bool
bson_append_minkey (bson_t *bson,
const char *key,
int key_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>key</p></td><td><p>An ASCII C string containing the name of the field.</p></td></tr>
<tr><td><p>key_length</p></td><td><p>The length of <code>key</code> in bytes, or -1 to determine the length with <code>strlen()</code>.</p></td></tr>
</table>
</section>
<section id="description">
<title>Description</title>
<p>The <code xref="bson_append_minkey">bson_append_minkey()</code> function shall append an element of type BSON_TYPE_MINKEY to a bson document. This is primarily used in queries and unlikely to be used when storing a document to MongoDB.</p>
</section>
<section id="return">
<title>Returns</title>
<p>true if the operation was applied successfully, otherwise false and <code>bson</code> should be discarded.</p>
</section>
</page>