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

  <section id="synopsis">
    <title>Synopsis</title>
    <synopsis><code mime="text/x-csrc"><![CDATA[mongoc_gridfs_file_t *
mongoc_gridfs_find_one_by_filename (mongoc_gridfs_t *gridfs,
                                    const char      *filename,
                                    bson_error_t    *error);]]></code></synopsis>
  </section>

  <section id="parameters">
    <title>Parameters</title>
    <table>
      <tr><td><p>gridfs</p></td><td><p>A <link xref="mongoc_gridfs_t">mongoc_gridfs_t</link>.</p></td></tr>
      <tr><td><p>filename</p></td><td><p>A UTF-8 encoded string contiaining the filename.</p></td></tr>
      <tr><td><p>error</p></td><td><p>An optional location for a <link xref="bson_error_t">bson_error_t</link> or <code>NULL</code>.</p></td></tr>
    </table>
  </section>

  <section id="description">
    <title>Description</title>
    <p>Finds the first file matching the filename specified. If no file could be found, NULL is returned and error is set.</p>
  </section>

  <section id="errors">
    <title>Errors</title>
    <p>Errors are propagated via the <code>error</code> parameter.</p>
  </section>

  <section id="return">
    <title>Returns</title>
    <p>Returns a newly allocated <link xref="mongoc_gridfs_file_t">mongoc_gridfs_file_t</link> if successful, otherwise NULL and error is set. You must free the resulting file with <link xref="mongoc_gridfs_file_destroy">mongoc_gridfs_file_destroy()</link> when no longer in use.</p>
  </section>

</page>
