ares_set_sortlist.3 (1436B)
1 .\" 2 .\" Copyright (C) Daniel Stenberg 3 .\" SPDX-License-Identifier: MIT 4 .\" 5 .TH ARES_SET_SORTLIST 3 "23 November 2015" 6 .SH NAME 7 ares_set_sortlist \- Initialize an ares_channel_t *sortlist configuration 8 .SH SYNOPSIS 9 .nf 10 #include <ares.h> 11 12 int ares_set_sortlist(ares_channel_t *\fIchannel\fP, const char *\fIsortstr\fP) 13 .fi 14 .SH DESCRIPTION 15 The \fBares_set_sortlist(3)\fP function initializes an address sortlist configuration 16 for the channel data identified by 17 .IR channel , 18 so that addresses returned by \fBares_gethostbyname(3)\fP are sorted according to the 19 sortlist. The provided 20 .IR sortstr 21 string that holds a space separated list of IP-address-netmask pairs. The 22 netmask is optional but follows the address after a slash if present. For example, 23 "130.155.160.0/255.255.240.0 130.155.0.0". 24 25 This function replaces any potentially previously configured address sortlist 26 with the ones given in the configuration string. 27 28 .SH RETURN VALUES 29 .B ares_set_sortlist(3) 30 may return any of the following values: 31 .TP 15 32 .B ARES_SUCCESS 33 The sortlist configuration was successfully initialized. 34 .TP 15 35 .B ARES_ENOMEM 36 The process's available memory was exhausted. 37 .TP 15 38 .B ARES_ENODATA 39 The channel data identified by 40 .IR channel 41 was invalid. 42 .TP 15 43 .B ARES_ENOTINITIALIZED 44 c-ares library initialization not yet performed. 45 .SH SEE ALSO 46 .BR ares_init_options (3), 47 .BR ares_dup (3) 48 .SH AVAILABILITY 49 ares_set_sortlist(3) was added in c-ares 1.11.0