Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ares_free_data (3)

Name

ares_free_data - ares functions

Synopsis

#include <ares.h>

void ares_free_data(void *dataptr)

cc file.c -lcares

Description

ARES_FREE_DATA(3)          Library Functions Manual          ARES_FREE_DATA(3)



NAME
       ares_free_data - Free data allocated by several c-ares functions

SYNOPSIS
       #include <ares.h>

       void ares_free_data(void *dataptr)

       cc file.c -lcares

DESCRIPTION
       The  ares_free_data(3) function frees one or more data structures allo-
       cated 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(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).

       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.

       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.

       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.

       ares_parse_soa_reply(3)
            When  used  to  free  the data returned by ares_parse_soa_reply(3)
            this will free the ares_soa_reply structure, along with any  addi-
            tional 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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libcares |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+

SEE ALSO
       ares_get_servers(3),  ares_parse_srv_reply(3),  ares_parse_mx_reply(3),
       ares_parse_txt_reply(3), ares_parse_soa_reply(3)

AUTHOR
       Yang Tse

       Copyright 1998 by the Massachusetts Institute of Technology.
       Copyright (C) 2004-2010 by Daniel Stenberg.



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://c-ares.haxx.se/download/c-
       ares-1.17.2.tar.gz.

       Further information about this software can be found on the open source
       community website at https://c-ares.haxx.se/.



                                 5 March 2010                ARES_FREE_DATA(3)