Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 9137e717b0
Branches Tags
curl
/
ares
/
ares_save_options.3

ares_save_options.3 2.0 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 
  1. .\" $Id$
    2. 

  2. .\"
    3. 

  3. .\" Copyright 1998 by the Massachusetts Institute of Technology.
    4. 

  4. .\"
    5. 

  5. .\" Permission to use, copy, modify, and distribute this
    6. 

  6. .\" software and its documentation for any purpose and without
    7. 

  7. .\" fee is hereby granted, provided that the above copyright
    8. 

  8. .\" notice appear in all copies and that both that copyright
    9. 

  9. .\" notice and this permission notice appear in supporting
    10. 

  10. .\" documentation, and that the name of M.I.T. not be used in
    11. 

  11. .\" advertising or publicity pertaining to distribution of the
    12. 

  12. .\" software without specific, written prior permission.
    13. 

  13. .\" M.I.T. makes no representations about the suitability of
    14. 

  14. .\" this software for any purpose.  It is provided "as is"
    15. 

  15. .\" without express or implied warranty.
    16. 

  16. .\"
    17. 

  17. .TH ARES_SAVE_OPTIONS 3 "1 June 2007"
    18. 

  18. .SH NAME
    19. 

  19. ares_save_options \- Save configuration values obtained from initialized ares_channel
    20. 

  20. .SH SYNOPSIS
    21. 

  21. .nf
    22. 

  22. .B #include <ares.h>
    23. 

  23. .PP
    24. 

  24. .B void ares_save_options(ares_channel \fIchannel\fP, struct ares_options *\fIoptions\fP, int *\fIoptmask\fP)
    25. 

  25. .fi
    26. 

  26. .SH DESCRIPTION
    27. 

  27. The \fBares_save_options(3)\fP function saves the channel data identified by
    28. 

  28. .IR channel ,
    29. 

  29. into the options struct identified by
    30. 

  30. .IR options ,
    31. 

  31. and saves the mask of options which are set to the integer
    32. 

  32. pointer (passed by reference) identified by
    33. 

  33. .IR optmask .
    34. 

  34. 

  35. The resultant options and optmask are then able to be
    36. 

  36. passed directly to ares_init_options.  When the options
    37. 

  37. are no longer needed, ares_destroy_options should be called
    38. 

  38. to free any associated memory.
    39. 

  39. .SH NOTE
    40. 

  40. Since c-ares 1.6.0 the ares_options struct has been "locked" meaning that it
    41. 

  41. won't be extended to cover new funtions. This function will remain
    42. 

  42. functioning, but it can only return config data that can be represented in
    43. 

  43. this config struct, which may no longer be the complete set of config
    44. 

  44. options. \fBares_dup(3)\fP will not have that restriction.
    45. 

  45. .SH SEE ALSO
    46. 

  46. .BR ares_destroy_options (3),
    47. 

  47. .BR ares_init_options (3),
    48. 

  48. .BR ares_dup (3)
    49. 

  49. .SH AVAILABILITY
    50. 

  50. ares_save_options(3) was added in c-ares 1.4.0
    51. 

  51. .SH AUTHOR
    52. 

  52. Brad House
    53. 

  53. .br
    54. 

  54. Copyright 1998 by the Massachusetts Institute of Technology.
    55.