bson_append_minkey(3)
| BSON_APPEND_MINKEY(3) | Libbson | BSON_APPEND_MINKEY(3) |
NAME
bson_append_minkey - bson_append_minkey()
SYNOPSIS
#define BSON_APPEND_MINKEY(b, key) \
bson_append_minkey (b, key, (int) strlen (key)) bool bson_append_minkey (bson_t *bson, const char *key, int key_length);
PARAMETERS
- bson: A bson_t.
- key: An ASCII C string containing the name of the field.
- key_length: The length of key in bytes, or -1 to determine the length with strlen().
DESCRIPTION
The bson_append_minkey() 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.
RETURNS
Returns true if the operation was applied successfully. The function will fail if appending the value grows bson larger than INT32_MAX.
AUTHOR
MongoDB, Inc
COPYRIGHT
2017-present, MongoDB, Inc
| June 1, 2021 | 1.14.0 |