Support Watt-32 under Win32.
[platform/upstream/c-ares.git] / ares_free_hostent.3
1 .\" $Id$
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 \fIares_parse_a_reply(3)\fP,
32 \fIares_parse_aaaa_reply(3)\fP, or \fIares_parse_ptr_reply(3)\fP.
33 .SH NOTES
34 It is not necessary (and is not correct) to free the host structure passed to
35 the callback functions for \fIares_gethostbyname(3)\fP or
36 \fIares_gethostbyaddr(3)\fP. c-ares will automatically free such host
37 structures when the callback returns.
38 .SH SEE ALSO
39 .BR ares_parse_a_reply (3),
40 .BR ares_parse_aaaa_reply (3),
41 .BR ares_parse_ptr_reply (3),
42 .BR ares_parse_ns_reply (3)
43 .SH AUTHOR
44 Greg Hudson, MIT Information Systems
45 .br
46 Copyright 1998 by the Massachusetts Institute of Technology.