ares_set_sortlist (3)

Leading comments

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

(The comments found at the beginning of the groff file "man3/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 configuration 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.

SEE ALSO

ares_init_options(3), ares_dup(3)

AVAILABILITY

ares_set_sortlist(3) was added in c-ares 1.11.0