ares_free_data.3 (2359B)
1 .\" 2 .\" Copyright 1998 by the Massachusetts Institute of Technology. 3 .\" Copyright (C) 2004-2010 by Daniel Stenberg 4 .\" SPDX-License-Identifier: MIT 5 .\" 6 .TH ARES_FREE_DATA 3 "5 March 2010" 7 .SH NAME 8 ares_free_data \- Free data allocated by several c-ares functions 9 .SH SYNOPSIS 10 .nf 11 #include <ares.h> 12 13 void ares_free_data(void *\fIdataptr\fP) 14 .fi 15 .SH DESCRIPTION 16 .PP 17 The \fBares_free_data(3)\fP function frees one or more data structures 18 allocated and returned by several c-ares functions. Specifically the data 19 returned by the following list of functions must be deallocated using this 20 function. 21 .TP 5 22 .B ares_get_servers(3) 23 When used to free the data returned by \fIares_get_servers(3)\fP this will 24 free the whole linked list of ares_addr_node structures returned by 25 \fIares_get_servers(3)\fP. 26 .TP 27 .B ares_parse_srv_reply(3) 28 When used to free the data returned by \fIares_parse_srv_reply(3)\fP this will 29 free the whole linked list of ares_srv_reply structures returned by 30 \fIares_parse_srv_reply(3)\fP, along with any additional storage associated 31 with those structures. 32 .TP 33 .B ares_parse_mx_reply(3) 34 When used to free the data returned by \fIares_parse_mx_reply(3)\fP this will 35 free the whole linked list of ares_mx_reply structures returned by 36 \fIares_parse_mx_reply(3)\fP, along with any additional storage associated 37 with those structures. 38 .TP 39 .B ares_parse_txt_reply(3) 40 When used to free the data returned by \fIares_parse_txt_reply(3)\fP this will 41 free the whole linked list of ares_txt_reply structures returned by 42 \fIares_parse_txt_reply(3)\fP, along with any additional storage associated 43 with those structures. 44 .TP 45 .B ares_parse_soa_reply(3) 46 When used to free the data returned by \fIares_parse_soa_reply(3)\fP this will 47 free the ares_soa_reply structure, along with any additional storage 48 associated with those structure. 49 .B ares_parse_uri_reply(3) 50 When used to free the data returned by \fIares_parse_uri_reply(3)\fP this will 51 free list of ares_uri_reply structures, along with any additional storage 52 associated with those structure. 53 .SH RETURN VALUE 54 The \fIares_free_data(3)\fP function does not return a value. 55 .SH AVAILABILITY 56 This function was first introduced in c-ares version 1.7.0. 57 .SH SEE ALSO 58 .BR ares_get_servers (3), 59 .BR ares_parse_srv_reply (3), 60 .BR ares_parse_mx_reply (3), 61 .BR ares_parse_txt_reply (3), 62 .BR ares_parse_soa_reply (3)