contrib/bind-9.3/lib/lwres/man/lwres_hstrerror.3

   1 .\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and 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 .\" $Id: lwres_hstrerror.3,v 1.13.2.1.8.5 2005/10/13 02:33:53 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\" ** You probably do not want to edit this file directly **
  21 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
  22 .\" Instead of manually editing it, you probably should edit the DocBook XML
  23 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
  24 .TH "LWRES_HSTRERROR" "3" "Jun 30, 2000" "BIND9" "BIND9"
  25 .\" disable hyphenation
  26 .nh
  27 .\" disable justification (adjust text to left margin only)
  28 .ad l
  29 .SH "NAME"
  30 lwres_herror, lwres_hstrerror \- lightweight resolver error message generation
  31 .SH "SYNOPSIS"
  32 .nf
  33 #include <lwres/netdb.h>
  34 .fi
  35 .HP 18
  36 \fBvoid\ \fBlwres_herror\fR\fR\fB(\fR\fBconst\ char\ *s\fR\fB);\fR
  37 .HP 29
  38 \fBconst\ char\ *\ \fBlwres_hstrerror\fR\fR\fB(\fR\fBint\ err\fR\fB);\fR
  39 .SH "DESCRIPTION"
  40 .PP
  41 \fBlwres_herror()\fR
  42 prints the string
  43 \fIs\fR
  44 on
  45 \fBstderr\fR
  46 followed by the string generated by
  47 \fBlwres_hstrerror()\fR
  48 for the error code stored in the global variable
  49 \fBlwres_h_errno\fR.
  50 .PP
  51 \fBlwres_hstrerror()\fR
  52 returns an appropriate string for the error code gievn by
  53 \fIerr\fR. The values of the error codes and messages are as follows:
  54 .TP
  55 \fBNETDB_SUCCESS\fR
  56 Resolver Error 0 (no error)
  57 .TP
  58 \fBHOST_NOT_FOUND\fR
  59 Unknown host
  60 .TP
  61 \fBTRY_AGAIN\fR
  62 Host name lookup failure
  63 .TP
  64 \fBNO_RECOVERY\fR
  65 Unknown server error
  66 .TP
  67 \fBNO_DATA\fR
  68 No address associated with name
  69 .SH "RETURN VALUES"
  70 .PP
  71 The string
  72 Unknown resolver error
  73 is returned by
  74 \fBlwres_hstrerror()\fR
  75 when the value of
  76 \fBlwres_h_errno\fR
  77 is not a valid error code.
  78 .SH "SEE ALSO"
  79 .PP
  80 \fBherror\fR(3),
  81 \fBlwres_hstrerror\fR(3).