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

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