libares/ares_free_hostent.3

   1 .\" $Id: ares_free_hostent.3,v 1.1 1998/08/13 18:07:30 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_FREE_HOSTENT 3 "23 July 1998"
  18 .SH NAME
  19 ares_free_hostent \- Free host structure allocated by ares functions
  20 .SH SYNOPSIS
  21 .nf
  22 .B #include <ares.h>
  23 .PP
  24 .B void ares_free_hostent(struct hostent *\fIhost\fP)
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .I ares_free_hostent
  29 function frees a
  30 .B struct hostent
  31 allocated by one of the functions
  32 .I ares_parse_a_reply
  33 or
  34 .IR ares_parse_ptr_reply .
  35 .SH SEE ALSO
  36 .BR ares_parse_a_reply (3),
  37 .BR ares_parse_ptr_reply (3)
  38 .SH NOTES
  39 It is not necessary (and is not correct) to free the host structure
  40 passed to the callback functions for
  41 .I ares_gethostbyname
  42 or
  43 .IR ares_gethostbyaddr .
  44 The ares library will automatically free such host structures when the
  45 callback returns.
  46 .SH AUTHOR
  47 Greg Hudson, MIT Information Systems
  48 .br
  49 Copyright 1998 by the Massachusetts Institute of Technology.