1BSON_APPEND_MAXKEY(3) libbson BSON_APPEND_MAXKEY(3)
2
3
4
6 bson_append_maxkey - bson_append_maxkey()
7
9 #define BSON_APPEND_MAXKEY(b, key) \
10 bson_append_maxkey (b, key, (int) strlen (key))
11
12 bool
13 bson_append_maxkey (bson_t *bson, const char *key, int key_length);
14
16 · bson: A bson_t.
17
18 · key: An ASCII C string containing the name of the field.
19
20 · key_length: The length of key in bytes, or -1 to determine the length
21 with strlen().
22
24 The bson_append_maxkey() function shall append an element of type
25 BSON_TYPE_MAXKEY to a bson document. This is primarily used in queries
26 and unlikely to be used when storing a document to MongoDB.
27
29 Returns true if the operation was applied successfully. The function
30 will fail if appending the value grows bson larger than INT32_MAX.
31
33 MongoDB, Inc
34
36 2017-present, MongoDB, Inc
37
38
39
40
411.16.2 Feb 25, 2020 BSON_APPEND_MAXKEY(3)