lwres_hstrerror.docbook revision 194e2dfffa6a167b8eef0ad11864026b423a1c30
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<!--
b0e8629055a766d4555a005a283c2889a5974945Mark Andrews - Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews -
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - This Source Code Form is subject to the terms of the Mozilla Public
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - License, v. 2.0. If a copy of the MPL was not distributed with this
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - file, You can obtain one at http://mozilla.org/MPL/2.0/.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson-->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews<!-- Converted by db4-upgrade version 1.0 -->
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <info>
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews <date>2007-06-18</date>
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews </info>
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews <refentryinfo>
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews <corpname>ISC</corpname>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
b0e8629055a766d4555a005a283c2889a5974945Mark Andrews </refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refmeta>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>lwres_hstrerror</refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <manvolnum>3</manvolnum>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews <refmiscinfo>BIND9</refmiscinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refmeta>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews <docinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2000</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2001</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2004</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2005</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2007</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2014</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2015</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2016</year>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </docinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname>lwres_herror</refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname>lwres_hstrerror</refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refpurpose>lightweight resolver error message generation</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsynopsisdiv>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews <funcsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvoid
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_herror</function></funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <paramdef>const char *<parameter>s</parameter></paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <funcdef>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrewsconst char *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<function>lwres_hstrerror</function></funcdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <paramdef>int <parameter>err</parameter></paramdef>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </funcprototype>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</funcsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsynopsisdiv>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsection><info><title>DESCRIPTION</title></info>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><function>lwres_herror()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein prints the string <parameter>s</parameter> on
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <type>stderr</type> followed by the string generated by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <function>lwres_hstrerror()</function> for the error code stored
b0e8629055a766d4555a005a283c2889a5974945Mark Andrews in the global variable <constant>lwres_h_errno</constant>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><function>lwres_hstrerror()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein returns an appropriate string for the error code gievn by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <parameter>err</parameter>. The values of the error codes and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein messages are as follows:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><errorcode>NETDB_SUCCESS</errorcode></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><errorname>Resolver Error 0 (no error)</errorname>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </para>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson </listitem>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson </varlistentry>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson <varlistentry>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson <term><errorcode>HOST_NOT_FOUND</errorcode></term>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson <listitem>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson <para><errorname>Unknown host</errorname>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson </para>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson </listitem>
8eea877894ea5bcf5cdd9ca124a8601ad421d753Andreas Gustafsson </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><errorcode>TRY_AGAIN</errorcode></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><errorname>Host name lookup failure</errorname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><errorcode>NO_RECOVERY</errorcode></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><errorname>Unknown server error</errorname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><errorcode>NO_DATA</errorcode></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><errorname>No address associated with name</errorname>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsection>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsection><info><title>RETURN VALUES</title></info>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The string <errorname>Unknown resolver error</errorname> is returned by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <function>lwres_hstrerror()</function>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein when the value of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <constant>lwres_h_errno</constant>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is not a valid error code.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsection>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsection><info><title>SEE ALSO</title></info>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>herror</refentrytitle><manvolnum>3</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>lwres_hstrerror</refentrytitle><manvolnum>3</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsection>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein