contrib/bind9/lib/lwres/man/lwres_hstrerror.3

   1 .\" Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .hy 0
  17 .ad l
  18 '\" t
  19 .\"     Title: lwres_hstrerror
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
  22 .\"      Date: 2007-06-18
  23 .\"    Manual: BIND9
  24 .\"    Source: ISC
  25 .\"  Language: English
  26 .\"
  27 .TH "LWRES_HSTRERROR" "3" "2007\-06\-18" "ISC" "BIND9"
  28 .\" -----------------------------------------------------------------
  29 .\" * Define some portability stuff
  30 .\" -----------------------------------------------------------------
  31 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32 .\" http://bugs.debian.org/507673
  33 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .ie \n(.g .ds Aq \(aq
  36 .el       .ds Aq '
  37 .\" -----------------------------------------------------------------
  38 .\" * set default formatting
  39 .\" -----------------------------------------------------------------
  40 .\" disable hyphenation
  41 .nh
  42 .\" disable justification (adjust text to left margin only)
  43 .ad l
  44 .\" -----------------------------------------------------------------
  45 .\" * MAIN CONTENT STARTS HERE *
  46 .\" -----------------------------------------------------------------
  47 .SH "NAME"
  48 lwres_herror, lwres_hstrerror \- lightweight resolver error message generation
  49 .SH "SYNOPSIS"
  50 .sp
  51 .ft B
  52 .nf
  53 #include <lwres/netdb\&.h>
  54 .fi
  55 .ft
  56 .HP \w'void\ lwres_herror('u
  57 .BI "void lwres_herror(const\ char\ *" "s" ");"
  58 .HP \w'const\ char\ *\ lwres_hstrerror('u
  59 .BI "const char * lwres_hstrerror(int\ " "err" ");"
  60 .SH "DESCRIPTION"
  61 .PP
  62 \fBlwres_herror()\fR
  63 prints the string
  64 \fIs\fR
  65 on
  66 \fBstderr\fR
  67 followed by the string generated by
  68 \fBlwres_hstrerror()\fR
  69 for the error code stored in the global variable
  70 \fBlwres_h_errno\fR\&.
  71 .PP
  72 \fBlwres_hstrerror()\fR
  73 returns an appropriate string for the error code gievn by
  74 \fIerr\fR\&. The values of the error codes and messages are as follows:
  75 .PP
  76 \fBNETDB_SUCCESS\fR
  77 .RS 4
  78 Resolver Error 0 (no error)
  79 .RE
  80 .PP
  81 \fBHOST_NOT_FOUND\fR
  82 .RS 4
  83 Unknown host
  84 .RE
  85 .PP
  86 \fBTRY_AGAIN\fR
  87 .RS 4
  88 Host name lookup failure
  89 .RE
  90 .PP
  91 \fBNO_RECOVERY\fR
  92 .RS 4
  93 Unknown server error
  94 .RE
  95 .PP
  96 \fBNO_DATA\fR
  97 .RS 4
  98 No address associated with name
  99 .RE
 100 .SH "RETURN VALUES"
 101 .PP
 102 The string
 103 Unknown resolver error
 104 is returned by
 105 \fBlwres_hstrerror()\fR
 106 when the value of
 107 \fBlwres_h_errno\fR
 108 is not a valid error code\&.
 109 .SH "SEE ALSO"
 110 .PP
 111 \fBherror\fR(3),
 112 \fBlwres_hstrerror\fR(3)\&.
 113 .SH "AUTHOR"
 114 .PP
 115 \fBInternet Systems Consortium, Inc\&.\fR
 116 .SH "COPYRIGHT"
 117 .br
 118 Copyright \(co 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
 119 .br
 120 Copyright \(co 2000, 2001 Internet Software Consortium.
 121 .br