summaryrefslogtreecommitdiffstats
path: root/lib/lwres/man/lwres_hstrerror.docbook
blob: 8f83428c76c53c5545905a10818f151c437bd560 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<!--
 - 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>