ares_free_hostent.3 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .\"
  2. .\" Copyright 1998 by the Massachusetts Institute of Technology.
  3. .\"
  4. .\" Permission to use, copy, modify, and distribute this
  5. .\" software and its documentation for any purpose and without
  6. .\" fee is hereby granted, provided that the above copyright
  7. .\" notice appear in all copies and that both that copyright
  8. .\" notice and this permission notice appear in supporting
  9. .\" documentation, and that the name of M.I.T. not be used in
  10. .\" advertising or publicity pertaining to distribution of the
  11. .\" software without specific, written prior permission.
  12. .\" M.I.T. makes no representations about the suitability of
  13. .\" this software for any purpose. It is provided "as is"
  14. .\" without express or implied warranty.
  15. .\"
  16. .TH ARES_FREE_HOSTENT 3 "23 July 1998"
  17. .SH NAME
  18. ares_free_hostent \- Free host structure allocated by ares functions
  19. .SH SYNOPSIS
  20. .nf
  21. .B #include <ares.h>
  22. .PP
  23. .B void ares_free_hostent(struct hostent *\fIhost\fP)
  24. .fi
  25. .SH DESCRIPTION
  26. The
  27. .I ares_free_hostent
  28. function frees a
  29. .B struct hostent
  30. allocated by one of the functions \fIares_parse_a_reply(3)\fP,
  31. \fIares_parse_aaaa_reply(3)\fP, or \fIares_parse_ptr_reply(3)\fP.
  32. .SH NOTES
  33. It is not necessary (and is not correct) to free the host structure passed to
  34. the callback functions for \fIares_gethostbyname(3)\fP or
  35. \fIares_gethostbyaddr(3)\fP. c-ares will automatically free such host
  36. structures when the callback returns.
  37. .SH SEE ALSO
  38. .BR ares_parse_a_reply (3),
  39. .BR ares_parse_aaaa_reply (3),
  40. .BR ares_parse_ptr_reply (3),
  41. .BR ares_parse_ns_reply (3)
  42. .SH AUTHOR
  43. Greg Hudson, MIT Information Systems
  44. .br
  45. Copyright 1998 by the Massachusetts Institute of Technology.