<?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_end">
  <info>
    <link type="guide" xref="bson_t" group="function"/>
  </info>
  <title>bson_append_document_end()</title>

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

  <section id="parameters">
    <title>Parameters</title>
    <table>
      <tr><td><p>bson</p></td><td><p>A <link xref="bson_t">bson_t</link>.</p></td></tr>
      <tr><td><p>child</p></td><td><p>The child <link xref="bson_t">bson_t</link> initialized in a call to <link xref="bson_append_document_begin">bson_append_document_begin()</link>.</p></td></tr>
    </table>
  </section>

  <section id="description">
    <title>Description</title>
    <p>The <link xref="bson_append_document_end">bson_append_document_end()</link> function shall complete the appending of a document with <link xref="bson_append_document_begin">bson_append_document_begin()</link>. <code>child</code> is invalid after calling this function.</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>
