external/bsd/bind/dist/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, 2014  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 <refentry>
  22
  23   <refentryinfo>
  24     <date>June 18, 2007</date>
  25   </refentryinfo>
  26
  27   <refmeta>
  28     <refentrytitle>lwres_hstrerror</refentrytitle>
  29     <manvolnum>3</manvolnum>
  30     <refmiscinfo>BIND9</refmiscinfo>
  31   </refmeta>
  32
  33   <docinfo>
  34     <copyright>
  35       <year>2004</year>
  36       <year>2005</year>
  37       <year>2007</year>
  38       <year>2014</year>
  39       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  40     </copyright>
  41     <copyright>
  42       <year>2000</year>
  43       <year>2001</year>
  44       <holder>Internet Software Consortium.</holder>
  45     </copyright>
  46   </docinfo>
  47
  48   <refnamediv>
  49     <refname>lwres_herror</refname>
  50     <refname>lwres_hstrerror</refname>
  51     <refpurpose>lightweight resolver error message generation</refpurpose>
  52   </refnamediv>
  53   <refsynopsisdiv>
  54     <funcsynopsis>
  55 <funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
  56 <funcprototype>
  57         <funcdef>
  58 void
  59 <function>lwres_herror</function></funcdef>
  60         <paramdef>const char *<parameter>s</parameter></paramdef>
  61         </funcprototype>
  62 <funcprototype>
  63         <funcdef>
  64 const char *
  65 <function>lwres_hstrerror</function></funcdef>
  66         <paramdef>int <parameter>err</parameter></paramdef>
  67       </funcprototype>
  68 </funcsynopsis>
  69   </refsynopsisdiv>
  70
  71   <refsect1>
  72     <title>DESCRIPTION</title>
  73
  74     <para><function>lwres_herror()</function>
  75       prints the string <parameter>s</parameter> on
  76       <type>stderr</type> followed by the string generated by
  77       <function>lwres_hstrerror()</function> for the error code stored
  78       in the global variable <constant>lwres_h_errno</constant>.
  79     </para>
  80
  81     <para><function>lwres_hstrerror()</function>
  82       returns an appropriate string for the error code gievn by
  83       <parameter>err</parameter>.  The values of the error codes and
  84       messages are as follows:
  85
  86       <variablelist>
  87         <varlistentry>
  88           <term><errorcode>NETDB_SUCCESS</errorcode></term>
  89           <listitem>
  90             <para><errorname>Resolver Error 0 (no error)</errorname>
  91             </para>
  92           </listitem>
  93         </varlistentry>
  94         <varlistentry>
  95           <term><errorcode>HOST_NOT_FOUND</errorcode></term>
  96           <listitem>
  97             <para><errorname>Unknown host</errorname>
  98             </para>
  99           </listitem>
 100         </varlistentry>
 101         <varlistentry>
 102           <term><errorcode>TRY_AGAIN</errorcode></term>
 103           <listitem>
 104             <para><errorname>Host name lookup failure</errorname>
 105             </para>
 106           </listitem>
 107         </varlistentry>
 108         <varlistentry>
 109           <term><errorcode>NO_RECOVERY</errorcode></term>
 110           <listitem>
 111             <para><errorname>Unknown server error</errorname>
 112             </para>
 113           </listitem>
 114         </varlistentry>
 115         <varlistentry>
 116           <term><errorcode>NO_DATA</errorcode></term>
 117           <listitem>
 118             <para><errorname>No address associated with name</errorname>
 119             </para>
 120           </listitem>
 121         </varlistentry>
 122       </variablelist>
 123     </para>
 124   </refsect1>
 125
 126   <refsect1>
 127     <title>RETURN VALUES</title>
 128     <para>
 129       The string <errorname>Unknown resolver error</errorname> is returned by
 130       <function>lwres_hstrerror()</function>
 131       when the value of
 132       <constant>lwres_h_errno</constant>
 133       is not a valid error code.
 134     </para>
 135   </refsect1>
 136   <refsect1>
 137     <title>SEE ALSO</title>
 138     <para><citerefentry>
 139         <refentrytitle>herror</refentrytitle><manvolnum>3</manvolnum>
 140       </citerefentry>,
 141
 142       <citerefentry>
 143         <refentrytitle>lwres_hstrerror</refentrytitle><manvolnum>3</manvolnum>
 144       </citerefentry>.
 145     </para>
 146
 147   </refsect1>
 148 </refentry><!--
 149  - Local variables:
 150  - mode: sgml
 151  - End:
 152 -->