lib/libares/ares_strerror.3

   1 .\" $Id: ares_strerror.3,v 1.1 1998/08/13 18:07:36 ghudson Exp $
   2 .\"
   3 .\" Copyright 1998 by the Massachusetts Institute of Technology.
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this
   6 .\" software and its documentation for any purpose and without
   7 .\" fee is hereby granted, provided that the above copyright
   8 .\" notice appear in all copies and that both that copyright
   9 .\" notice and this permission notice appear in supporting
  10 .\" documentation, and that the name of M.I.T. not be used in
  11 .\" advertising or publicity pertaining to distribution of the
  12 .\" software without specific, written prior permission.
  13 .\" M.I.T. makes no representations about the suitability of
  14 .\" this software for any purpose.  It is provided "as is"
  15 .\" without express or implied warranty.
  16 .\"
  17 .TH ARES_STRERROR 3 "25 July 1998"
  18 .SH NAME
  19 ares_strerror \- Get the description of an ares library error code
  20 .SH SYNOPSIS
  21 .nf
  22 .B #include <ares.h>
  23 .PP
  24 .B const char *ares_strerror(int \fIcode\fP, char **\fImemptr\fP)
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .B ares_strerror
  29 function gets the description of the ares library error code
  30 .IR code ,
  31 returning the result as a NUL-terminated C string.  A pointer to
  32 allocated data necessary to compose the error description may be
  33 stored in the variable pointed to by
  34 .IR memptr .
  35 It is the caller's responsibility to invoke
  36 .BR ares_free_errmem (3)
  37 with the value of that variable when the error description is no
  38 longer needed.
  39 .SH SEE ALSO
  40 .BR ares_free_errmem (3)
  41 .SH AUTHOR
  42 Greg Hudson, MIT Information Systems
  43 .br
  44 Copyright 1998 by the Massachusetts Institute of Technology.