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

  <section id="synopsis">
    <title>Synopsis</title>
    <synopsis><code mime="text/x-csrc"><![CDATA[bool
mongoc_read_prefs_is_valid (const mongoc_read_prefs_t *read_prefs);
]]></code></synopsis>
  </section>

  <section id="parameters">
    <title>Parameters</title>
    <table>
      <tr><td><p>read_prefs</p></td><td><p>A <link xref="mongoc_read_prefs_t">mongoc_read_prefs_t</link>.</p></td></tr>
    </table>
  </section>

  <section id="description">
    <title>Description</title>
    <p>Performs a consistency check of <code>read_prefs</code> to ensure it makes sense and can be satisfied.</p>
    <p>This only performs local consistency checks.</p>
  </section>

  <section id="return">
    <title>Returns</title>
    <p>Returns true if the read pref is valid.</p>
  </section>

</page>
