Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# bson_append_document()

## Synopsis

    #define BSON_APPEND_DOCUMENT(b, key, val) \
       bson_append_document (b, key, (int) strlen (key), val)

    bool
    bson_append_document (bson_t *bson,
                          const char *key,
                          int key_length,
                          const bson_t *value);

## 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()`.

- `value`: A bson_t containing the sub-document to append.

## Description

The bson_append_document() function shall append `child` to `bson` using the specified key. The type of the field will be a document.

## Returns

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