/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook

  1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  2               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
  3	       [<!ENTITY mdash "&#8212;">]>
  4<!--
  5 - Copyright (C) 2004, 2005, 2007, 2012  Internet Systems Consortium, Inc. ("ISC")
  6 - Copyright (C) 2000, 2001  Internet Software Consortium.
  7 -
  8 - Permission to use, copy, modify, and/or distribute this software for any
  9 - purpose with or without fee is hereby granted, provided that the above
 10 - copyright notice and this permission notice appear in all copies.
 11 -
 12 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 13 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 14 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 15 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 16 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 17 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 18 - PERFORMANCE OF THIS SOFTWARE.
 19-->
 20
 21<!-- $Id$ -->
 22<refentry>
 23
 24  <refentryinfo>
 25    <date>Jun 30, 2000</date>
 26  </refentryinfo>
 27
 28  <refmeta>
 29    <refentrytitle>lwres_hstrerror</refentrytitle>
 30    <manvolnum>3</manvolnum>
 31    <refmiscinfo>BIND9</refmiscinfo>
 32  </refmeta>
 33
 34  <docinfo>
 35    <copyright>
 36      <year>2004</year>
 37      <year>2005</year>
 38      <year>2007</year>
 39      <year>2012</year>
 40      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
 41    </copyright>
 42    <copyright>
 43      <year>2000</year>
 44      <year>2001</year>
 45      <holder>Internet Software Consortium.</holder>
 46    </copyright>
 47  </docinfo>
 48
 49  <refnamediv>
 50    <refname>lwres_herror</refname>
 51    <refname>lwres_hstrerror</refname>
 52    <refpurpose>lightweight resolver error message generation</refpurpose>
 53  </refnamediv>
 54  <refsynopsisdiv>
 55    <funcsynopsis>
 56<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
 57<funcprototype>
 58        <funcdef>
 59void
 60<function>lwres_herror</function></funcdef>
 61        <paramdef>const char *<parameter>s</parameter></paramdef>
 62        </funcprototype>
 63<funcprototype>
 64        <funcdef>
 65const char *
 66<function>lwres_hstrerror</function></funcdef>
 67        <paramdef>int <parameter>err</parameter></paramdef>
 68      </funcprototype>
 69</funcsynopsis>
 70  </refsynopsisdiv>
 71
 72  <refsect1>
 73    <title>DESCRIPTION</title>
 74
 75    <para><function>lwres_herror()</function>
 76      prints the string <parameter>s</parameter> on
 77      <type>stderr</type> followed by the string generated by
 78      <function>lwres_hstrerror()</function> for the error code stored
 79      in the global variable <constant>lwres_h_errno</constant>.
 80    </para>
 81
 82    <para><function>lwres_hstrerror()</function>
 83      returns an appropriate string for the error code gievn by
 84      <parameter>err</parameter>.  The values of the error codes and
 85      messages are as follows:
 86
 87      <variablelist>
 88        <varlistentry>
 89          <term><errorcode>NETDB_SUCCESS</errorcode></term>
 90          <listitem>
 91            <para><errorname>Resolver Error 0 (no error)</errorname>
 92            </para>
 93          </listitem>
 94        </varlistentry>
 95        <varlistentry>
 96          <term><errorcode>HOST_NOT_FOUND</errorcode></term>
 97          <listitem>
 98            <para><errorname>Unknown host</errorname>
 99            </para>
100          </listitem>
101        </varlistentry>
102        <varlistentry>
103          <term><errorcode>TRY_AGAIN</errorcode></term>
104          <listitem>
105            <para><errorname>Host name lookup failure</errorname>
106            </para>
107          </listitem>
108        </varlistentry>
109        <varlistentry>
110          <term><errorcode>NO_RECOVERY</errorcode></term>
111          <listitem>
112            <para><errorname>Unknown server error</errorname>
113            </para>
114          </listitem>
115        </varlistentry>
116        <varlistentry>
117          <term><errorcode>NO_DATA</errorcode></term>
118          <listitem>
119            <para><errorname>No address associated with name</errorname>
120            </para>
121          </listitem>
122        </varlistentry>
123      </variablelist>
124    </para>
125  </refsect1>
126
127  <refsect1>
128    <title>RETURN VALUES</title>
129    <para>
130      The string <errorname>Unknown resolver error</errorname> is returned by
131      <function>lwres_hstrerror()</function>
132      when the value of
133      <constant>lwres_h_errno</constant>
134      is not a valid error code.
135    </para>
136  </refsect1>
137  <refsect1>
138    <title>SEE ALSO</title>
139    <para><citerefentry>
140        <refentrytitle>herror</refentrytitle><manvolnum>3</manvolnum>
141      </citerefentry>,
142
143      <citerefentry>
144        <refentrytitle>lwres_hstrerror</refentrytitle><manvolnum>3</manvolnum>
145      </citerefentry>.
146    </para>
147
148  </refsect1>
149</refentry><!--
150 - Local variables:
151 - mode: sgml
152 - End:
153-->