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

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000, 2001  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and 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: lwres_hstrerror.docbook,v 1.4.206.3 2005/05/12 21:36:15 sra Exp $ -->
  22
  23 <refentry>
  24
  25 <refentryinfo>
  26 <date>Jun 30, 2000</date>
  27 </refentryinfo>
  28
  29 <refmeta>
  30 <refentrytitle>lwres_hstrerror</refentrytitle>
  31 <manvolnum>3</manvolnum>
  32 <refmiscinfo>BIND9</refmiscinfo>
  33 </refmeta>
  34
  35   <docinfo>
  36     <copyright>
  37       <year>2004</year>
  38       <year>2005</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 *s</paramdef>
  61 </funcprototype>
  62 <funcprototype>
  63 <funcdef>
  64 const char *
  65 <function>lwres_hstrerror</function></funcdef>
  66 <paramdef>int err</paramdef>
  67 </funcprototype>
  68 </funcsynopsis>
  69 </refsynopsisdiv>
  70
  71 <refsect1>
  72 <title>DESCRIPTION</title>
  73
  74 <para>
  75 <function>lwres_herror()</function> prints the string
  76 <parameter>s</parameter> on <type>stderr</type> followed by the string
  77 generated by <function>lwres_hstrerror()</function> for the error code
  78 stored in the global variable <constant>lwres_h_errno</constant>.
  79 </para>
  80
  81 <para>
  82 <function>lwres_hstrerror()</function> returns an appropriate string
  83 for the error code gievn by <parameter>err</parameter>.  The values of
  84 the error codes and messages are as follows:
  85
  86 <variablelist>
  87 <varlistentry><term><errorcode>NETDB_SUCCESS</errorcode></term>
  88 <listitem>
  89 <para>
  90 <errorname>Resolver Error 0 (no error)</errorname>
  91 </para></listitem></varlistentry>
  92 <varlistentry><term><errorcode>HOST_NOT_FOUND</errorcode></term>
  93 <listitem>
  94 <para>
  95 <errorname>Unknown host</errorname>
  96 </para></listitem></varlistentry>
  97 <varlistentry><term><errorcode>TRY_AGAIN</errorcode></term>
  98 <listitem>
  99 <para>
 100 <errorname>Host name lookup failure</errorname>
 101 </para></listitem></varlistentry>
 102 <varlistentry><term><errorcode>NO_RECOVERY</errorcode></term>
 103 <listitem>
 104 <para>
 105 <errorname>Unknown server error</errorname>
 106 </para></listitem></varlistentry>
 107 <varlistentry><term><errorcode>NO_DATA</errorcode></term>
 108 <listitem>
 109 <para>
 110 <errorname>No address associated with name</errorname>
 111 </para></listitem></varlistentry>
 112 </variablelist>
 113 </para>
 114 </refsect1>
 115
 116 <refsect1>
 117 <title>RETURN VALUES</title>
 118 <para>
 119 The string <errorname>Unknown resolver error</errorname> is returned by
 120 <function>lwres_hstrerror()</function>
 121 when the value of
 122 <constant>lwres_h_errno</constant>
 123 is not a valid error code.
 124 </para>
 125 </refsect1>
 126 <refsect1>
 127 <title>SEE ALSO</title>
 128 <para>
 129 <citerefentry>
 130 <refentrytitle>herror</refentrytitle><manvolnum>3</manvolnum>
 131 </citerefentry>,
 132
 133 <citerefentry>
 134 <refentrytitle>lwres_hstrerror</refentrytitle><manvolnum>3</manvolnum>
 135 </citerefentry>.
 136 </para>
 137
 138 </refsect1>
 139 </refentry>