From 4259d2df7dd95637a4b1e3fb174fe5e5aef81069 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Wed, 24 Mar 2010 10:34:30 +0100 Subject: remove the ares subtree c-ares is now hosted entirely separate from the curl project see http://c-ares.haxx.se/ for all details concerning c-ares, its source repository and more. --- ares/ares_save_options.3 | 75 ------------------------------------------------ 1 file changed, 75 deletions(-) delete mode 100644 ares/ares_save_options.3 (limited to 'ares/ares_save_options.3') diff --git a/ares/ares_save_options.3 b/ares/ares_save_options.3 deleted file mode 100644 index 0dd4b4ecb..000000000 --- a/ares/ares_save_options.3 +++ /dev/null @@ -1,75 +0,0 @@ -.\" $Id$ -.\" -.\" Copyright 1998 by the Massachusetts Institute of Technology. -.\" -.\" 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 suitability of -.\" this software for any purpose. It is provided "as is" -.\" without express or implied warranty. -.\" -.TH ARES_SAVE_OPTIONS 3 "5 March 2010" -.SH NAME -ares_save_options \- Save configuration values obtained from initialized ares_channel -.SH SYNOPSIS -.nf -.B #include -.PP -.B int ares_save_options(ares_channel \fIchannel\fP, struct ares_options *\fIoptions\fP, int *\fIoptmask\fP) -.fi -.SH DESCRIPTION -The \fBares_save_options(3)\fP function saves the channel data identified by -.IR channel , -into the options struct identified by -.IR options , -and saves the mask of options which are set to the integer -pointer (passed by reference) identified by -.IR optmask . - -The resultant options and optmask are then able to be -passed directly to ares_init_options. When the options -are no longer needed, ares_destroy_options should be called -to free any associated memory. -.SH RETURN VALUES -.B ares_save_options(3) -can return any of the following values: -.TP 15 -.B ARES_SUCCESS -The channel data was successfuly stored -.TP 15 -.B ARES_ENOMEM -The memory was exhausted -.TP 15 -.B ARES_ENODATA -The channel data identified by -.IR channel -were invalid. -.SH NOTE -Since c-ares 1.6.0 the ares_options struct has been "locked" meaning that it -won't be extended to cover new functions. This function will remain -functioning, but it can only return config data that can be represented in -this config struct, which may no longer be the complete set of config -options. \fBares_dup(3)\fP will not have that restriction. - -The ares_options struct can not handle potential IPv6 name servers the -ares_channel might be configured to use. Function \fBares_save_options(3)\fP -will only return IPv4 servers if any. In order to retrieve all name servers -an ares_channel might be using, function \fBares_get_servers(3)\fP must be -used instead. -.SH SEE ALSO -.BR ares_destroy_options (3), -.BR ares_init_options (3), -.BR ares_get_servers (3), -.BR ares_dup (3) -.SH AVAILABILITY -ares_save_options(3) was added in c-ares 1.4.0 -.SH AUTHOR -Brad House -.br -Copyright 1998 by the Massachusetts Institute of Technology. -- cgit v1.2.3