diff options
Diffstat (limited to 'contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook')
-rw-r--r-- | contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook b/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook new file mode 100644 index 000000000000..2ad4c498e7e7 --- /dev/null +++ b/contrib/bind9/lib/lwres/man/lwres_hstrerror.docbook @@ -0,0 +1,124 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- + - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2001 Internet Software Consortium. + - + - Permission to use, copy, modify, and distribute this software for any + - purpose with or without fee is hereby granted, provided that the above + - copyright notice and this permission notice appear in all copies. + - + - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH + - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM + - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE + - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR + - PERFORMANCE OF THIS SOFTWARE. +--> + +<!-- $Id: lwres_hstrerror.docbook,v 1.4.206.1 2004/03/06 08:15:41 marka Exp $ --> + +<refentry> + +<refentryinfo> +<date>Jun 30, 2000</date> +</refentryinfo> + +<refmeta> +<refentrytitle>lwres_hstrerror</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo>BIND9</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>lwres_herror</refname> +<refname>lwres_hstrerror</refname> +<refpurpose>lightweight resolver error message generation</refpurpose> +</refnamediv> +<refsynopsisdiv> +<funcsynopsis> +<funcsynopsisinfo>#include <lwres/netdb.h></funcsynopsisinfo> +<funcprototype> +<funcdef> +void +<function>lwres_herror</function></funcdef> +<paramdef>const char *s</paramdef> +</funcprototype> +<funcprototype> +<funcdef> +const char * +<function>lwres_hstrerror</function></funcdef> +<paramdef>int err</paramdef> +</funcprototype> +</funcsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>DESCRIPTION</title> + +<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> +</refsect1> + +<refsect1> +<title>RETURN VALUES</title> +<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> +</refsect1> +<refsect1> +<title>SEE ALSO</title> +<para> +<citerefentry> +<refentrytitle>herror</refentrytitle><manvolnum>3</manvolnum> +</citerefentry>, + +<citerefentry> +<refentrytitle>lwres_hstrerror</refentrytitle><manvolnum>3</manvolnum> +</citerefentry>. +</para> + +</refsect1> +</refentry> |