mirror of https://github.com/c-ares/c-ares.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
49 lines
1.6 KiB
49 lines
1.6 KiB
.\" $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 "1 June 2007" |
|
.SH NAME |
|
ares_save_options \- Save configuration values obtained from initialized ares_channel |
|
.SH SYNOPSIS |
|
.nf |
|
.B #include <ares.h> |
|
.PP |
|
.B void ares_save_options(ares_channel \fIchannel\fP, struct ares_options *\fIoptions\fP, int *\fIoptmask\fP) |
|
.fi |
|
.SH DESCRIPTION |
|
The |
|
.B ares_save_options |
|
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 SEE ALSO |
|
.BR ares_destroy_options (3), |
|
.BR ares_init_options (3) |
|
.SH AUTHOR |
|
Brad House |
|
.br |
|
Copyright 1998 by the Massachusetts Institute of Technology.
|
|
|