NAME

       bson_append_document_begin()  -  The  bson_append_document_begin()  function shall begin appending a sub-
       document  to  bson.  Use  child   to   add   fields   to   the   sub-document.   When   completed,   call
       bson_append_document_end() to complete the element.

SYNOPSIS

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

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

       child  An uninitialized bson_t to be initialized as the sub‐document.

DESCRIPTION

       The  bson_append_document_begin(3) function shall begin appending a sub‐document to bson \&. Use child to
       add fields to the sub‐document. When completed, call bson_append_document_end(3) to complete the element.

       child

       MUST be an uninitialized bson_t to avoid leaking memory.

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.

libbson                                            2016‐01‐18                      BSON_APPEND_DOCUMENT_BEGIN(3)