<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.5">
  <compounddef id="group__suffix" kind="group">
    <compoundname>suffix</compoundname>
    <title>Suffix-based operations</title>
      <sectiondef kind="func">
      <memberdef kind="function" id="group__suffix_1ga80fc6d3116b8a9dc1e8cc5a7a0932615" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_suffix_get</definition>
        <argsstring>(qdb_handle_t handle, const char *suffix, qdb_int_t max_count, const char ***results, size_t *result_count)</argsstring>
        <name>qdb_suffix_get</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>suffix</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga17492cb84da5466d0c742f0561df6597" kindref="member">qdb_int_t</ref></type>
          <declname>max_count</declname>
        </param>
        <param>
          <type>const char ***</type>
          <declname>results</declname>
        </param>
        <param>
          <type>size_t *</type>
          <declname>result_count</declname>
        </param>
        <briefdescription>
<para>Retrieves the list of all entries matching the provided suffix. </para>        </briefdescription>
        <detaileddescription>
<para>A suffix-based search will enable you to find all entries matching a provided <computeroutput>suffix</computeroutput>.</para><para>This function returns the list of aliases. It&apos;s up to the user to query the content associated with every entry, if needed.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>suffix</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the desired suffix</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>max_count</parametername>
</parameternamelist>
<parameterdescription>
<para>An integer limiting the number of results returned by the function</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">results</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a list of results</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">result_count</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to an integer giving the results count</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1ga31b15fb83e60b9cb16504618616f29f3" kindref="member">qdb_release</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/suffix.h" line="69" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__suffix_1gabc2e3ecf513b7b2d17f950c9ca0bd23e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_suffix_count</definition>
        <argsstring>(qdb_handle_t handle, const char *suffix, qdb_uint_t *result_count)</argsstring>
        <name>qdb_suffix_count</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>suffix</declname>
        </param>
        <param>
          <type>qdb_uint_t *</type>
          <declname>result_count</declname>
        </param>
        <briefdescription>
<para>Retrieves the count of all entries matching the provided suffix. </para>        </briefdescription>
        <detaileddescription>
<para>A suffix-based count counts all entries matching a provided suffix.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>suffix</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the desired suffix</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">result_count</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to an integer giving the results count</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/suffix.h" line="91" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__suffix_1gac169b5e435b8c47c4e55ea77da81d407" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_suffix_approximate_count</definition>
        <argsstring>(qdb_handle_t handle, const char *suffix, qdb_uint_t *result_count)</argsstring>
        <name>qdb_suffix_approximate_count</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>suffix</declname>
        </param>
        <param>
          <type>qdb_uint_t *</type>
          <declname>result_count</declname>
        </param>
        <briefdescription>
<para>Retrieves the <emphasis>approximate</emphasis> count of all entries matching the provided suffix. </para>        </briefdescription>
        <detaileddescription>
<para>A suffix-based count counts all entries matching a provided suffix.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>suffix</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the desired suffix</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">result_count</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to an integer giving the results count</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/suffix.h" line="113" column="1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>
