ares_free_data()

Name

ares_free_data - Free data allocated by several c-ares functions

Synopsis

#include <ares.h>
 
void ares_free_data(void *dataptr)

Description

The ares_free_data 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.

ares_get_servers When used to free the data returned by ares_get_servers this will free the whole linked list of ares_addr_node structures returned by ares_get_servers.

ares_parse_srv_reply When used to free the data returned by ares_parse_srv_reply this will free the whole linked list of ares_srv_reply structures returned by ares_parse_srv_reply, along with any additional storage associated with those structures.

ares_parse_mx_reply When used to free the data returned by ares_parse_mx_reply this will free the whole linked list of ares_mx_reply structures returned by ares_parse_mx_reply, along with any additional storage associated with those structures.

ares_parse_txt_reply When used to free the data returned by ares_parse_txt_reply this will free the whole linked list of ares_txt_reply structures returned by ares_parse_txt_reply, along with any additional storage associated with those structures.

ares_parse_soa_reply When used to free the data returned by ares_parse_soa_reply this will free the ares_soa_reply structure, along with any additional storage associated with those structure. ares_parse_uri_reply When used to free the data returned by ares_parse_uri_reply this will free list of ares_uri_reply structures, along with any additional storage associated with those structure.

Return value

The ares_free_data function does not return a value.

Availability

This function was first introduced in c-ares version 1.7.0.

Author

Yang Tse