diff options
author | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 13:54:38 -0700 |
---|---|---|
committer | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 13:54:38 -0700 |
commit | b8e6c26b7b9608dffc84645f17fe4cf534af18dd (patch) | |
tree | 61d9fff2984aa043471a1c305cfc4c76d7a099fb /ares_free_data.3 | |
download | c-ares-b8e6c26b7b9608dffc84645f17fe4cf534af18dd.tar.gz c-ares-b8e6c26b7b9608dffc84645f17fe4cf534af18dd.tar.bz2 c-ares-b8e6c26b7b9608dffc84645f17fe4cf534af18dd.zip |
Imported Upstream version 1.7.5upstream/1.7.5
Diffstat (limited to 'ares_free_data.3')
-rw-r--r-- | ares_free_data.3 | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/ares_free_data.3 b/ares_free_data.3 new file mode 100644 index 0000000..c6cadd5 --- /dev/null +++ b/ares_free_data.3 @@ -0,0 +1,72 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" Copyright (C) 2004-2010 by Daniel Stenberg +.\" +.\" Permission to use, copy, modify, and distribute this +.\" software and its documentation for any purpose and without +.\" fee is hereby granted, provided that the above copyright +.\" notice appear in all copies and that both that copyright +.\" notice and this permission notice appear in supporting +.\" documentation, and that the name of M.I.T. not be used in +.\" advertising or publicity pertaining to distribution of the +.\" software without specific, written prior permission. +.\" M.I.T. makes no representations about the suitability of +.\" this software for any purpose. It is provided "as is" +.\" without express or implied warranty. +.\" +.TH ARES_FREE_DATA 3 "5 March 2010" +.SH NAME +ares_free_data \- Free data allocated by several c-ares functions +.SH SYNOPSIS +.nf +.B #include <ares.h> +.PP +.B void ares_free_data(void *\fIdataptr\fP) +.PP +.B cc file.c -lcares +.fi +.SH DESCRIPTION +.PP +The +.B ares_free_data(3) +function frees one or more data structures allocated and returned +by several c-ares functions. Specifically the data returned by the +following list of functions must be deallocated using this function. +.TP 5 +.B ares_get_servers(3) +When used to free the data returned by ares_get_servers(3) this +will free the whole linked list of ares_addr_node structures returned +by ares_get_servers(3). +.TP +.B ares_parse_srv_reply(3) +When used to free the data returned by ares_parse_srv_reply(3) this +will free the whole linked list of ares_srv_reply structures returned +by ares_parse_srv_reply(3), along with any additional storage +associated with those structures. +.TP +.B ares_parse_mx_reply(3) +When used to free the data returned by ares_parse_mx_reply(3) this +will free the whole linked list of ares_mx_reply structures returned +by ares_parse_mx_reply(3), along with any additional storage +associated with those structures. +.TP +.B ares_parse_txt_reply(3) +When used to free the data returned by ares_parse_txt_reply(3) this +will free the whole linked list of ares_txt_reply structures returned +by ares_parse_txt_reply(3), along with any additional storage +associated with those structures. +.SH RETURN VALUE +The ares_free_data() function does not return a value. +.SH AVAILABILITY +This function was first introduced in c-ares version 1.7.0. +.SH SEE ALSO +.BR ares_get_servers(3), +.BR ares_parse_srv_reply(3), +.BR ares_parse_mx_reply(3), +.BR ares_parse_txt_reply(3) +.SH AUTHOR +Yang Tse +.PP +Copyright 1998 by the Massachusetts Institute of Technology. +.br +Copyright (C) 2004-2010 by Daniel Stenberg. |