curl_easy_reset.3 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .TH curl_easy_reset 3 "31 July 2004" "libcurl 7.12.1" "libcurl Manual"
  25. .SH NAME
  26. curl_easy_reset - reset all options of a libcurl session handle
  27. .SH SYNOPSIS
  28. .nf
  29. #include <curl/curl.h>
  30. void curl_easy_reset(CURL *handle);
  31. .fi
  32. .SH DESCRIPTION
  33. Re-initializes all options previously set on a specified CURL handle to the
  34. default values. This puts back the handle to the same state as it was in when
  35. it was just created with \fIcurl_easy_init(3)\fP.
  36. It does not change the following information kept in the handle: live
  37. connections, the Session ID cache, the DNS cache, the cookies, the shares or
  38. the alt-svc cache.
  39. .SH EXAMPLE
  40. .nf
  41. CURL *curl = curl_easy_init();
  42. /* ... the handle is used and options are set ... */
  43. curl_easy_reset(curl);
  44. .fi
  45. .SH AVAILABILITY
  46. This function was added in libcurl 7.12.1
  47. .SH RETURN VALUE
  48. Nothing
  49. .SH "SEE ALSO"
  50. .BR curl_easy_init "(3)," curl_easy_cleanup "(3)," curl_easy_setopt "(3),"
  51. .BR curl_easy_duphandle "(3)"