Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ares_set_sortlist (3)

Name

ares_set_sortlist - Initialize an ares_channel sortlist configuration

Synopsis

#include <ares.h>

int ares_set_sortlist(ares_channel channel, const char *sortstr)

Description

ARES_SET_SORTLIST(3)       Library Functions Manual       ARES_SET_SORTLIST(3)



NAME
       ares_set_sortlist - Initialize an ares_channel sortlist configuration

SYNOPSIS
       #include <ares.h>

       int ares_set_sortlist(ares_channel channel, const char *sortstr)

DESCRIPTION
       The  ares_set_sortlist(3) function initializes an address sortlist con-
       figuration  for  the  channel  data  identified  by  channel,  so  that
       addresses returned by ares_gethostbyname(3) are sorted according to the
       sortlist.  The provided sortstr string that  holds  a  space  separated
       list  of IP-address-netmask pairs.  The netmask is optional but follows
       the   address   after   a   slash    if    present.     For    example,
       "130.155.160.0/255.255.240.0 130.155.0.0".

       This  function  replaces  any potentially previously configured address
       sortlist with the ones given in the configuration string.


RETURN VALUES
       ares_set_sortlist(3) may return any of the following values:

       ARES_SUCCESS   The sortlist configuration was successfully initialized.

       ARES_ENOMEM    The process's available memory was exhausted.

       ARES_ENODATA   The channel data identified by channel was invalid.

       ARES_ENOTINITIALIZED
                      c-ares library initialization not yet performed.


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


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

SEE ALSO
       ares_init_options(3), ares_dup(3)

AVAILABILITY
       ares_set_sortlist(3) was added in c-ares 1.11.0



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/.



                               23 November 2015           ARES_SET_SORTLIST(3)