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

  <section id="synopsis">
    <title>Synopsis</title>
    <synopsis><code mime="text/x-csrc"><![CDATA[const uint8_t *
bson_get_data (const bson_t *bson);
]]></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>
    </table>
  </section>

  <section id="description">
    <title>Description</title>
    <p>The <code xref="bson_get_data">bson_get_data()</code> function shall return the raw buffer of a bson document. This can be used in conjunction with the <code>len</code> property of a <code xref="bson_t">bson_t</code> if you want to copy the raw buffer around.</p>
  </section>

  <section id="return">
    <title>Returns</title>
    <p>A buffer which should not be modified or freed.</p>
  </section>

</page>
