bson_append_maxkey() — libbson 1.9.2

- libbson 1.9.2 »
- API Reference »
- bson_t

# bson_append_maxkey()

## Synopsis

    #define BSON_APPEND_MAXKEY(b, key) \
       bson_append_maxkey (b, key, (int) strlen (key))

    bool
    bson_append_maxkey (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_maxkey() function shall append an element of type BSON_TYPE_MAXKEY 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.

Created using Sphinx 1.6.5, based on Sphinx Readable Theme.