1BSON_APPEND_MAXKEY(3)               libbson              BSON_APPEND_MAXKEY(3)
2
3
4

SYNOPSIS

6          #define BSON_APPEND_MAXKEY(b, key) \
7             bson_append_maxkey (b, key, (int) strlen (key))
8
9          bool
10          bson_append_maxkey (bson_t *bson, const char *key, int key_length);
11

PARAMETERS

13       • bson: A bson_t.
14
15       • key: An ASCII C string containing the name of the field.
16
17       • key_length: The length of key in bytes, or -1 to determine the length
18         with strlen().
19

DESCRIPTION

21       The bson_append_maxkey() function  shall  append  an  element  of  type
22       BSON_TYPE_MAXKEY  to a bson document. This is primarily used in queries
23       and unlikely to be used when storing a document to MongoDB.
24

RETURNS

26       Returns true if the operation was applied  successfully.  The  function
27       will fail if appending the value grows bson larger than INT32_MAX.
28

AUTHOR

30       MongoDB, Inc
31

33       2017-present, MongoDB, Inc
34
35
36
37
381.25.1                           Nov 08, 2023            BSON_APPEND_MAXKEY(3)
Impressum