<!--
 - Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 -
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
 -
 - See the COPYRIGHT file distributed with this work for additional
 - information regarding copyright ownership.
-->

<!-- Converted by db4-upgrade version 1.0 -->
<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0">
  <info>
    <date>2007-06-18</date>
  </info>
  <refentryinfo>
    <corpname>ISC</corpname>
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
  </refentryinfo>

  <refmeta>
    <refentrytitle>lwres_hstrerror</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <docinfo>
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <year>2004</year>
      <year>2005</year>
      <year>2007</year>
      <year>2014</year>
      <year>2015</year>
      <year>2016</year>
      <year>2018</year>
      <year>2019</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refnamediv>
    <refname>lwres_herror</refname>
    <refname>lwres_hstrerror</refname>
    <refpurpose>lightweight resolver error message generation</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis>
<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
<funcprototype>
        <funcdef>
void
<function>lwres_herror</function></funcdef>
        <paramdef>const char *<parameter>s</parameter></paramdef>
        </funcprototype>
<funcprototype>
        <funcdef>
const char *
<function>lwres_hstrerror</function></funcdef>
        <paramdef>int <parameter>err</parameter></paramdef>
      </funcprototype>
</funcsynopsis>
  </refsynopsisdiv>

  <refsection><info><title>DESCRIPTION</title></info>


    <para><function>lwres_herror()</function>
      prints the string <parameter>s</parameter> on
      <type>stderr</type> followed by the string generated by
      <function>lwres_hstrerror()</function> for the error code stored
      in the global variable <constant>lwres_h_errno</constant>.
    </para>

    <para><function>lwres_hstrerror()</function>
      returns an appropriate string for the error code gievn by
      <parameter>err</parameter>.  The values of the error codes and
      messages are as follows:

      <variablelist>
        <varlistentry>
          <term><errorcode>NETDB_SUCCESS</errorcode></term>
          <listitem>
            <para><errorname>Resolver Error 0 (no error)</errorname>
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>HOST_NOT_FOUND</errorcode></term>
          <listitem>
            <para><errorname>Unknown host</errorname>
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>TRY_AGAIN</errorcode></term>
          <listitem>
            <para><errorname>Host name lookup failure</errorname>
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>NO_RECOVERY</errorcode></term>
          <listitem>
            <para><errorname>Unknown server error</errorname>
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>NO_DATA</errorcode></term>
          <listitem>
            <para><errorname>No address associated with name</errorname>
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
    </para>
  </refsection>

  <refsection><info><title>RETURN VALUES</title></info>

    <para>
      The string <errorname>Unknown resolver error</errorname> is returned by
      <function>lwres_hstrerror()</function>
      when the value of
      <constant>lwres_h_errno</constant>
      is not a valid error code.
    </para>
  </refsection>
  <refsection><info><title>SEE ALSO</title></info>

    <para><citerefentry>
        <refentrytitle>herror</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>lwres_hstrerror</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>.
    </para>

  </refsection>
</refentry>
