lwres_hstrerror.docbook revision 19c7b1a0293498a3e36692c59646ed6e15ffc8d0
5d92fff82718cd018f0b61a10b9ad4d2b8064c95rpluem<!--
bf52162f2d05c1fb1a107c7ef108de73f739b3edpquerna - Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
aec9747aa70c1dce98e536e8eef5a6a0ab0f1d6cjim - Copyright (C) 2000, 2001 Internet Software Consortium.
aec9747aa70c1dce98e536e8eef5a6a0ab0f1d6cjim -
8dea7832dea3789fe0b90c434c284bcaad96d40fcovener - Permission to use, copy, modify, and/or distribute this software for any
8dea7832dea3789fe0b90c434c284bcaad96d40fcovener - purpose with or without fee is hereby granted, provided that the above
999661242470e4dc0258982d5f183efc2d157ae7covener - copyright notice and this permission notice appear in all copies.
0bfcc4d046f6735af2f15981fb53e4c0680b4731covener -
b761a57b4e63006c287823270876ab40d3212160covener - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
b761a57b4e63006c287823270876ab40d3212160covener - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
b761a57b4e63006c287823270876ab40d3212160covener - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b761a57b4e63006c287823270876ab40d3212160covener - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5d92fff82718cd018f0b61a10b9ad4d2b8064c95rpluem - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5d92fff82718cd018f0b61a10b9ad4d2b8064c95rpluem - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5d92fff82718cd018f0b61a10b9ad4d2b8064c95rpluem - PERFORMANCE OF THIS SOFTWARE.
5d92fff82718cd018f0b61a10b9ad4d2b8064c95rpluem-->
01195d035ccef88e72009e9607157d5eddcb6b7drjung
01195d035ccef88e72009e9607157d5eddcb6b7drjung<!-- Converted by db4-upgrade version 1.0 -->
aec9747aa70c1dce98e536e8eef5a6a0ab0f1d6cjim<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
84fbf855118f318dd5e511d8e5b902cecc1177c0jim <info>
84fbf855118f318dd5e511d8e5b902cecc1177c0jim <date>2007-06-18</date>
0ed19acadd3d3dd593759173d87d2243e97914e2sf </info>
0ed19acadd3d3dd593759173d87d2243e97914e2sf <refentryinfo>
0ed19acadd3d3dd593759173d87d2243e97914e2sf <corpname>ISC</corpname>
0ed19acadd3d3dd593759173d87d2243e97914e2sf <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
cb838cc4d5fd559efd6c0579a0fcb8f6e5a7af22minfrin </refentryinfo>
cb838cc4d5fd559efd6c0579a0fcb8f6e5a7af22minfrin
cb838cc4d5fd559efd6c0579a0fcb8f6e5a7af22minfrin <refmeta>
cb838cc4d5fd559efd6c0579a0fcb8f6e5a7af22minfrin <refentrytitle>lwres_hstrerror</refentrytitle>
15ff8c621815e8337abc10638f2b2853ee6fd076minfrin <manvolnum>3</manvolnum>
15ff8c621815e8337abc10638f2b2853ee6fd076minfrin <refmiscinfo>BIND9</refmiscinfo>
15ff8c621815e8337abc10638f2b2853ee6fd076minfrin </refmeta>
21ccb6cd9272c9066a8f5bb3e7785f46115289desf
21ccb6cd9272c9066a8f5bb3e7785f46115289desf <docinfo>
21ccb6cd9272c9066a8f5bb3e7785f46115289desf <copyright>
b0ac1e83f8582a9b5a72bff798ffb31a419c8adesf <year>2004</year>
b0ac1e83f8582a9b5a72bff798ffb31a419c8adesf <year>2005</year>
b0ac1e83f8582a9b5a72bff798ffb31a419c8adesf <year>2007</year>
b682e60dd82772dba52ba77138e494f15c00a551trawick <year>2014</year>
b682e60dd82772dba52ba77138e494f15c00a551trawick <year>2015</year>
b682e60dd82772dba52ba77138e494f15c00a551trawick <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
b682e60dd82772dba52ba77138e494f15c00a551trawick </copyright>
b682e60dd82772dba52ba77138e494f15c00a551trawick <copyright>
b682e60dd82772dba52ba77138e494f15c00a551trawick <year>2000</year>
79c754eb51681c3389cd966753e902c429f78939trawick <year>2001</year>
79c754eb51681c3389cd966753e902c429f78939trawick <holder>Internet Software Consortium.</holder>
79c754eb51681c3389cd966753e902c429f78939trawick </copyright>
8651de219ec5f595af20afdc9da41ce72aaa50d5minfrin </docinfo>
8651de219ec5f595af20afdc9da41ce72aaa50d5minfrin
8651de219ec5f595af20afdc9da41ce72aaa50d5minfrin <refnamediv>
8651de219ec5f595af20afdc9da41ce72aaa50d5minfrin <refname>lwres_herror</refname>
8fae12696bce44be9ce4c56888690cad8ac7b8f9sf <refname>lwres_hstrerror</refname>
8fae12696bce44be9ce4c56888690cad8ac7b8f9sf <refpurpose>lightweight resolver error message generation</refpurpose>
8fae12696bce44be9ce4c56888690cad8ac7b8f9sf </refnamediv>
8fae12696bce44be9ce4c56888690cad8ac7b8f9sf <refsynopsisdiv>
8fae12696bce44be9ce4c56888690cad8ac7b8f9sf <funcsynopsis>
8fae12696bce44be9ce4c56888690cad8ac7b8f9sf<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
d5612bd28e194390b2c74fcf712d564b0e002684sf<funcprototype>
d5612bd28e194390b2c74fcf712d564b0e002684sf <funcdef>
d5612bd28e194390b2c74fcf712d564b0e002684sfvoid
4ea161d94782fa56f4b36d496f35ff8577c43065covener<function>lwres_herror</function></funcdef>
4ea161d94782fa56f4b36d496f35ff8577c43065covener <paramdef>const char *<parameter>s</parameter></paramdef>
4ea161d94782fa56f4b36d496f35ff8577c43065covener </funcprototype>
b588214d6e6fe09abe709e83e894921fbc7e25c8covener<funcprototype>
b588214d6e6fe09abe709e83e894921fbc7e25c8covener <funcdef>
b588214d6e6fe09abe709e83e894921fbc7e25c8covenerconst char *
c64fc4e9830bb1ffdc3491aef5ed3be5b90c466bcovener<function>lwres_hstrerror</function></funcdef>
c64fc4e9830bb1ffdc3491aef5ed3be5b90c466bcovener <paramdef>int <parameter>err</parameter></paramdef>
c64fc4e9830bb1ffdc3491aef5ed3be5b90c466bcovener </funcprototype>
c64fc4e9830bb1ffdc3491aef5ed3be5b90c466bcovener</funcsynopsis>
ae5efbbf49a7ca6d233209a4d011550989e22556covener </refsynopsisdiv>
ae5efbbf49a7ca6d233209a4d011550989e22556covener
ae5efbbf49a7ca6d233209a4d011550989e22556covener <refsection><info><title>DESCRIPTION</title></info>
8c2bb916633b1eb3dccf91c776363bbc3a6145decovener
8c2bb916633b1eb3dccf91c776363bbc3a6145decovener
8c2bb916633b1eb3dccf91c776363bbc3a6145decovener <para><function>lwres_herror()</function>
8c2bb916633b1eb3dccf91c776363bbc3a6145decovener prints the string <parameter>s</parameter> on
503bec4c591d28ac6cec7182294cdef2ec6a9829covener <type>stderr</type> followed by the string generated by
503bec4c591d28ac6cec7182294cdef2ec6a9829covener <function>lwres_hstrerror()</function> for the error code stored
503bec4c591d28ac6cec7182294cdef2ec6a9829covener in the global variable <constant>lwres_h_errno</constant>.
503bec4c591d28ac6cec7182294cdef2ec6a9829covener </para>
c00149c3cb27e0381362d07ccf2143574b4f600dsf
c00149c3cb27e0381362d07ccf2143574b4f600dsf <para><function>lwres_hstrerror()</function>
c00149c3cb27e0381362d07ccf2143574b4f600dsf returns an appropriate string for the error code gievn by
766b0a4793197ccef3dfa202d1fee1e1f929ffa7sf <parameter>err</parameter>. The values of the error codes and
766b0a4793197ccef3dfa202d1fee1e1f929ffa7sf messages are as follows:
766b0a4793197ccef3dfa202d1fee1e1f929ffa7sf
97b692bfc8673c8858f03498f81a993ac0c04c01sf <variablelist>
97b692bfc8673c8858f03498f81a993ac0c04c01sf <varlistentry>
97b692bfc8673c8858f03498f81a993ac0c04c01sf <term><errorcode>NETDB_SUCCESS</errorcode></term>
5e6cf205d2b0c848e15c65dab9711805395a5108minfrin <listitem>
5e6cf205d2b0c848e15c65dab9711805395a5108minfrin <para><errorname>Resolver Error 0 (no error)</errorname>
5e6cf205d2b0c848e15c65dab9711805395a5108minfrin </para>
5e6cf205d2b0c848e15c65dab9711805395a5108minfrin </listitem>
df419be6d7d4b68823efa05722375552af49c2b6minfrin </varlistentry>
df419be6d7d4b68823efa05722375552af49c2b6minfrin <varlistentry>
df419be6d7d4b68823efa05722375552af49c2b6minfrin <term><errorcode>HOST_NOT_FOUND</errorcode></term>
df419be6d7d4b68823efa05722375552af49c2b6minfrin <listitem>
c03e31374e50a227cb554a0f1d4a9056ce80d99asf <para><errorname>Unknown host</errorname>
c03e31374e50a227cb554a0f1d4a9056ce80d99asf </para>
c03e31374e50a227cb554a0f1d4a9056ce80d99asf </listitem>
40b22d3b20454959fe51fdc89907908d77701078minfrin </varlistentry>
40b22d3b20454959fe51fdc89907908d77701078minfrin <varlistentry>
40b22d3b20454959fe51fdc89907908d77701078minfrin <term><errorcode>TRY_AGAIN</errorcode></term>
b4a00883f358625923365ca1560c96edec172a52sf <listitem>
b4a00883f358625923365ca1560c96edec172a52sf <para><errorname>Host name lookup failure</errorname>
b4a00883f358625923365ca1560c96edec172a52sf </para>
b4a00883f358625923365ca1560c96edec172a52sf </listitem>
0553e62d75ef12d9a6646bb874be1fbf9e4c1dfbsf </varlistentry>
0553e62d75ef12d9a6646bb874be1fbf9e4c1dfbsf <varlistentry>
0553e62d75ef12d9a6646bb874be1fbf9e4c1dfbsf <term><errorcode>NO_RECOVERY</errorcode></term>
87af9ffc3a42633fe12e11a0ff77bc099ecdca82sf <listitem>
f58bb3da705eb7ec926f4883597fc2eb1336a360minfrin <para><errorname>Unknown server error</errorname>
f58bb3da705eb7ec926f4883597fc2eb1336a360minfrin </para>
f58bb3da705eb7ec926f4883597fc2eb1336a360minfrin </listitem>
f58bb3da705eb7ec926f4883597fc2eb1336a360minfrin </varlistentry>
f58bb3da705eb7ec926f4883597fc2eb1336a360minfrin <varlistentry>
be192cefa381d5bae6868034687471754cb43175sf <term><errorcode>NO_DATA</errorcode></term>
be192cefa381d5bae6868034687471754cb43175sf <listitem>
be192cefa381d5bae6868034687471754cb43175sf <para><errorname>No address associated with name</errorname>
be192cefa381d5bae6868034687471754cb43175sf </para>
f4a0825e91eec135b5e41c697439e9a13014fa2cminfrin </listitem>
f4a0825e91eec135b5e41c697439e9a13014fa2cminfrin </varlistentry>
f4a0825e91eec135b5e41c697439e9a13014fa2cminfrin </variablelist>
f4a0825e91eec135b5e41c697439e9a13014fa2cminfrin </para>
5876f43a746f688a32b7201bced8591ddf19bd43minfrin </refsection>
5876f43a746f688a32b7201bced8591ddf19bd43minfrin
5876f43a746f688a32b7201bced8591ddf19bd43minfrin <refsection><info><title>RETURN VALUES</title></info>
5876f43a746f688a32b7201bced8591ddf19bd43minfrin
bbba414c5bbf770e505778265bbe7a4a0e4fbdaaniq <para>
bbba414c5bbf770e505778265bbe7a4a0e4fbdaaniq The string <errorname>Unknown resolver error</errorname> is returned by
bbba414c5bbf770e505778265bbe7a4a0e4fbdaaniq <function>lwres_hstrerror()</function>
4aef34911af88f96c5b6d9b71a550a5a97bbc0b6minfrin when the value of
4aef34911af88f96c5b6d9b71a550a5a97bbc0b6minfrin <constant>lwres_h_errno</constant>
4aef34911af88f96c5b6d9b71a550a5a97bbc0b6minfrin is not a valid error code.
4aef34911af88f96c5b6d9b71a550a5a97bbc0b6minfrin </para>
4aef34911af88f96c5b6d9b71a550a5a97bbc0b6minfrin </refsection>
4cefc38158672f5de8119886d9754cf0609a9371minfrin <refsection><info><title>SEE ALSO</title></info>
4cefc38158672f5de8119886d9754cf0609a9371minfrin
4cefc38158672f5de8119886d9754cf0609a9371minfrin <para><citerefentry>
4cefc38158672f5de8119886d9754cf0609a9371minfrin <refentrytitle>herror</refentrytitle><manvolnum>3</manvolnum>
4cefc38158672f5de8119886d9754cf0609a9371minfrin </citerefentry>,
11d3c510dca5b5178ad4739ffc1567ef2155bda9minfrin
11d3c510dca5b5178ad4739ffc1567ef2155bda9minfrin <citerefentry>
11d3c510dca5b5178ad4739ffc1567ef2155bda9minfrin <refentrytitle>lwres_hstrerror</refentrytitle><manvolnum>3</manvolnum>
d974a1624c0bb4f1c2e8b36fcf8ba1f12284ed8dsf </citerefentry>.
d974a1624c0bb4f1c2e8b36fcf8ba1f12284ed8dsf </para>
d974a1624c0bb4f1c2e8b36fcf8ba1f12284ed8dsf
1a8c329935111a5059363efe927d631371b78414minfrin </refsection>
1a8c329935111a5059363efe927d631371b78414minfrin</refentry>
fac37c9794a18c24d187f4e0f97a9476c4344118minfrin