lwres_hstrerror.docbook revision 83a28ca274521e15086fc39febde507bcc4e145e
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson<!--
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson - Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews -
a7038d1a0513c8e804937ebc95fc9cb3a46c04f5Mark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson - License, v. 2.0. If a copy of the MPL was not distributed with this
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson - file, You can obtain one at http://mozilla.org/MPL/2.0/.
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson-->
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson<!-- Converted by db4-upgrade version 1.0 -->
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0">
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews <info>
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews <date>2007-06-18</date>
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews </info>
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews <refentryinfo>
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews <corpname>ISC</corpname>
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews </refentryinfo>
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <refmeta>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <refentrytitle>lwres_hstrerror</refentrytitle>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <manvolnum>3</manvolnum>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <refmiscinfo>BIND9</refmiscinfo>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson </refmeta>
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson <docinfo>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <copyright>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <year>2000</year>
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews <year>2001</year>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <year>2004</year>
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews <year>2005</year>
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson <year>2007</year>
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews <year>2014</year>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <year>2015</year>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <year>2016</year>
e4c6adf028fedafcadee9e22e1e734e9e716471bAndreas Gustafsson <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
e4c6adf028fedafcadee9e22e1e734e9e716471bAndreas Gustafsson </copyright>
58c48b3b48f0de8fa31fc913aff3b8774c1e72e7Andreas Gustafsson </docinfo>
58c48b3b48f0de8fa31fc913aff3b8774c1e72e7Andreas Gustafsson
58c48b3b48f0de8fa31fc913aff3b8774c1e72e7Andreas Gustafsson <refnamediv>
58c48b3b48f0de8fa31fc913aff3b8774c1e72e7Andreas Gustafsson <refname>lwres_herror</refname>
58c48b3b48f0de8fa31fc913aff3b8774c1e72e7Andreas Gustafsson <refname>lwres_hstrerror</refname>
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews <refpurpose>lightweight resolver error message generation</refpurpose>
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews </refnamediv>
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews <refsynopsisdiv>
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews <funcsynopsis>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
a078776647dc80691fe97e2dd94a2525564df3ecMark Andrews<funcprototype>
49a6051082aac7ef5e358ba74791e94f5c456a15Andreas Gustafsson <funcdef>
49a6051082aac7ef5e358ba74791e94f5c456a15Andreas Gustafssonvoid
49a6051082aac7ef5e358ba74791e94f5c456a15Andreas Gustafsson<function>lwres_herror</function></funcdef>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <paramdef>const char *<parameter>s</parameter></paramdef>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson </funcprototype>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson<funcprototype>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <funcdef>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafssonconst char *
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson<function>lwres_hstrerror</function></funcdef>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson <paramdef>int <parameter>err</parameter></paramdef>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson </funcprototype>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson</funcsynopsis>
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson </refsynopsisdiv>
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson
58c48b3b48f0de8fa31fc913aff3b8774c1e72e7Andreas Gustafsson <refsection><info><title>DESCRIPTION</title></info>
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson <para><function>lwres_herror()</function>
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson prints the string <parameter>s</parameter> on
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson <type>stderr</type> followed by the string generated by
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson <function>lwres_hstrerror()</function> for the error code stored
336ca4423f475d9881ff0dcb326808935be7cd19Andreas Gustafsson in the global variable <constant>lwres_h_errno</constant>.
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson </para>
49a6051082aac7ef5e358ba74791e94f5c456a15Andreas Gustafsson
9d22ce85ccded7790a511dbe4065723f8d4f80a6Mark Andrews <para><function>lwres_hstrerror()</function>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson returns an appropriate string for the error code gievn by
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <parameter>err</parameter>. The values of the error codes and
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson messages are as follows:
43b9c76f5e8ad75226a2f58650b3f0be03f49994Andreas Gustafsson
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <variablelist>
9224b1c0b6738407c84b61cb151af7672a201018Andreas Gustafsson <varlistentry>
43b9c76f5e8ad75226a2f58650b3f0be03f49994Andreas Gustafsson <term><errorcode>NETDB_SUCCESS</errorcode></term>
e5a8e8cfd2c60f49fa359d2a79eb869e02c4033cAndreas Gustafsson <listitem>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <para><errorname>Resolver Error 0 (no error)</errorname>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson </para>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson </listitem>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson </varlistentry>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <varlistentry>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <term><errorcode>HOST_NOT_FOUND</errorcode></term>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <listitem>
49a6051082aac7ef5e358ba74791e94f5c456a15Andreas Gustafsson <para><errorname>Unknown host</errorname>
9224b1c0b6738407c84b61cb151af7672a201018Andreas Gustafsson </para>
9224b1c0b6738407c84b61cb151af7672a201018Andreas Gustafsson </listitem>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson </varlistentry>
21f17c42eca9b552d516c38b66564673c60a4504Andreas Gustafsson <varlistentry>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson <term><errorcode>TRY_AGAIN</errorcode></term>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson <listitem>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson <para><errorname>Host name lookup failure</errorname>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson </para>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson </listitem>
e4c6adf028fedafcadee9e22e1e734e9e716471bAndreas Gustafsson </varlistentry>
82493dc831d40482faf20cdb4d4295174879c9f9Andreas Gustafsson <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>