<?xml version="1.0"?>
<page xmlns="http://projectmallard.org/1.0/"
      type="topic"
      style="function"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/experimental/ui/"
      id="bson_append_document_begin">
  <info>
    <link type="guide" xref="bson_t" group="function"/>
  </info>
  <title>bson_append_document_begin()</title>

  <section id="synopsis">
    <title>Synopsis</title>
    <synopsis><code mime="text/x-csrc"><![CDATA[bool
bson_append_document_begin (bson_t     *bson,
                            const char *key,
                            int         key_length,
                            bson_t     *child);
]]></code></synopsis>
  </section>

  <section id="parameters">
    <title>Parameters</title>
    <table>
      <tr><td><p>bson</p></td><td><p>A <code xref="bson_t">bson_t</code>.</p></td></tr>
      <tr><td><p>key</p></td><td><p>An ASCII C string containing the name of the field.</p></td></tr>
      <tr><td><p>key_length</p></td><td><p>The length of <code>key</code> in bytes, or -1 to determine the length with <code>strlen()</code>.</p></td></tr>
      <tr><td><p>child</p></td><td><p>An uninitialized <code xref="bson_t">bson_t</code> to be initialized as the sub-document.</p></td></tr>
    </table>
  </section>

  <section id="description">
    <title>Description</title>
    <p>The <code xref="bson_append_document_begin">bson_append_document_begin()</code> function shall begin appending a sub-document to <code>bson</code>. Use <code>child</code> to add fields to the sub-document. When completed, call <code xref="bson_append_document_end">bson_append_document_end()</code> to complete the element.</p>
    <p><code>child</code> <em>MUST</em> be an uninitialized <code xref="bson_t">bson_t</code> to avoid leaking memory.</p>
  </section>

  <section id="return">
    <title>Returns</title>
    <p>true if the operation was applied successfully, otherwise false and <code>bson</code> should be discarded.</p>
  </section>
</page>
