bson_append_document (3) - Linux Manuals

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

NAME

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

SYNOPSIS

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(3) \&.

value

A bson_t containing the sub-document to append.

DESCRIPTION

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

RETURNS

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

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.