ares_save_options.3

   1 .\" $Id$
   2 .\"
   3 .\" Copyright 1998 by the Massachusetts Institute of Technology.
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this
   6 .\" software and its documentation for any purpose and without
   7 .\" fee is hereby granted, provided that the above copyright
   8 .\" notice appear in all copies and that both that copyright
   9 .\" notice and this permission notice appear in supporting
  10 .\" documentation, and that the name of M.I.T. not be used in
  11 .\" advertising or publicity pertaining to distribution of the
  12 .\" software without specific, written prior permission.
  13 .\" M.I.T. makes no representations about the suitability of
  14 .\" this software for any purpose.  It is provided "as is"
  15 .\" without express or implied warranty.
  16 .\"
  17 .TH ARES_SAVE_OPTIONS 3 "1 June 2007"
  18 .SH NAME
  19 ares_save_options \- Save configuration values obtained from initialized ares_channel
  20 .SH SYNOPSIS
  21 .nf
  22 .B #include <ares.h>
  23 .PP
  24 .B void ares_save_options(ares_channel \fIchannel\fP, struct ares_options *\fIoptions\fP, int *\fIoptmask\fP)
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .B ares_save_options
  29 function saves the channel data identified by
  30 .IR channel ,
  31 into the options struct identified by
  32 .IR options ,
  33 and saves the mask of options which are set to the integer
  34 pointer (passed by reference) identified by
  35 .IR optmask .
  36
  37 The resultant options and optmask are then able to be
  38 passed directly to ares_init_options.  When the options
  39 are no longer needed, ares_destroy_options should be called
  40 to free any associated memory.
  41
  42
  43 .SH SEE ALSO
  44 .BR ares_destroy_options (3),
  45 .BR ares_init_options (3)
  46 .SH AUTHOR
  47 Brad House
  48 .br
  49 Copyright 1998 by the Massachusetts Institute of Technology.