diff options
| author | Yang Tse <yangsita@gmail.com> | 2009-11-23 00:57:50 +0000 |
|---|---|---|
| committer | Yang Tse <yangsita@gmail.com> | 2009-11-23 00:57:50 +0000 |
| commit | 497afa9acb4d42b4bb186701f0d03a02884ff9b2 (patch) | |
| tree | e3fa308b13390cea964fb4d98be523abdef21061 /ares_save_options.3 | |
| parent | 17e6785e05bd19e7cac4aec96b781d5a41974e4b (diff) | |
| download | c-ares-497afa9acb4d42b4bb186701f0d03a02884ff9b2.tar.gz c-ares-497afa9acb4d42b4bb186701f0d03a02884ff9b2.tar.bz2 c-ares-497afa9acb4d42b4bb186701f0d03a02884ff9b2.zip | |
- Jakub Hrozek fixed more function prototypes in man pages to sync them
with the ones declared in ares.h
Diffstat (limited to 'ares_save_options.3')
| -rw-r--r-- | ares_save_options.3 | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/ares_save_options.3 b/ares_save_options.3 index 79f9db9..3434fc9 100644 --- a/ares_save_options.3 +++ b/ares_save_options.3 @@ -21,7 +21,7 @@ ares_save_options \- Save configuration values obtained from initialized ares_ch .nf .B #include <ares.h> .PP -.B void ares_save_options(ares_channel \fIchannel\fP, struct ares_options *\fIoptions\fP, int *\fIoptmask\fP) +.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 @@ -36,6 +36,20 @@ 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 funtions. This function will remain |