bson_append_minkey() — libbson 1.6.3

- libbson 1.6.3 »
- API Reference »
- bson_t

# bson_append_minkey()

## Synopsis

    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

true if the operation was applied successfully, otherwise false and `bson` should be discarded.

Created using Sphinx 1.5.3, based on Sphinx Readable Theme.