CURLOPT_COOKIEJAR.3 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2014, 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 http://curl.haxx.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. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_COOKIEJAR 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_COOKIEJAR \- file name to store cookies to
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEJAR, char *filename);
  29. .SH DESCRIPTION
  30. Pass a \fIfilename\fP as char *, zero terminated. This will make libcurl write
  31. all internally known cookies to the specified file when
  32. \fIcurl_easy_cleanup(3)\fP is called. If no cookies are known, no file will be
  33. created. Specify "-" as filename to instead have the cookies written to
  34. stdout. Using this option also enables cookies for this session, so if you for
  35. example follow a location it will make matching cookies get sent accordingly.
  36. Note that libcurl doesn't read any cookies from the cookie jar. If you want to
  37. read cookies from a file, use \fICURLOPT_COOKIEFILE(3)\fP.
  38. If the cookie jar file can't be created or written to (when the
  39. \fIcurl_easy_cleanup(3)\fP is called), libcurl will not and cannot report an
  40. error for this. Using \fICURLOPT_VERBOSE(3)\fP or
  41. \fICURLOPT_DEBUGFUNCTION(3)\fP will get a warning to display, but that is the
  42. only visible feedback you get about this possibly lethal situation.
  43. .SH DEFAULT
  44. NULL
  45. .SH PROTOCOLS
  46. HTTP
  47. .SH EXAMPLE
  48. TODO
  49. .SH AVAILABILITY
  50. Along with HTTP
  51. .SH RETURN VALUE
  52. Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
  53. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  54. .SH "SEE ALSO"
  55. .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "