bson_append_array_begin man page

bson_append_array_begin — bson_append_array_begin()

Synopsis

bool
bson_append_array_begin (bson_t *bson,
                         const char *key,
                         int key_length,
                         bson_t *child);

Parameters

  • bson: A bson_t.

  • key: A string containing the name for the key.

  • key_length: The length of key or -1 to call strlen().

  • child: A bson_t.

Description

The bson_append_array_begin() function shall begin appending an array field to bson. This allows for incrementally building a sub-array. Doing so will generally yield better performance as you will serialize to a single buffer. When done building the sub-array, the caller MUST call bson_append_array_end().

Returns

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

Author

MongoDB, Inc

Info

Mar 07, 2017 1.6.1 Libbson