bson_append_iter() — libbson 1.6.3

- libbson 1.6.3 »
- API Reference »
- bson_t

# bson_append_iter()

## Synopsis

    bool
    bson_append_iter (bson_t *bson,
                      const char *key,
                      int key_length,
                      const bson_iter_t *iter);

## Parameters

- `bson`: A bson_t.
- `key`: Optional field name. If NULL, uses bson_iter_key(iter).
- `key_length`: The length of `key` or -1 to use strlen().
- `iter`: A bson_iter_t located on the position of the element to append.

## Description

Appends the value at the current position of `iter` to the document.

## Returns

true if successful; false if append would overflow the maximum document size or another invalid state is detected.

Created using Sphinx 1.5.3, based on Sphinx Readable Theme.