CURLOPT_HSTSWRITEDATA.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_HSTSWRITEDATA 3 "14 Sep 2020" "libcurl 7.74.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_HSTSWRITEDATA \- pointer passed to the HSTS write callback
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSWRITEDATA, void *pointer);
  30. .fi
  31. .SH DESCRIPTION
  32. Data \fIpointer\fP to pass to the HSTS write function. If you use the
  33. \fICURLOPT_HSTSWRITEFUNCTION(3)\fP option, this is the pointer you will get as
  34. input in the 4th argument to the callback.
  35. This option does not enable HSTS, you need to use \fICURLOPT_HSTS_CTRL(3)\fP to
  36. do that.
  37. .SH DEFAULT
  38. NULL
  39. .SH PROTOCOLS
  40. This feature is only used for HTTP(S) transfer.
  41. .SH EXAMPLE
  42. .nf
  43. CURL *curl = curl_easy_init();
  44. struct MyData this;
  45. if(curl) {
  46. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  47. /* pass pointer that gets passed in to the
  48. CURLOPT_HSTSWRITEFUNCTION callback */
  49. curl_easy_setopt(curl, CURLOPT_HSTSWRITEDATA, &this);
  50. curl_easy_perform(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. Added in 7.74.0
  55. .SH RETURN VALUE
  56. This will return CURLE_OK.
  57. .SH "SEE ALSO"
  58. .BR CURLOPT_HSTSWRITEFUNCTION "(3), " CURLOPT_HSTSREADDATA "(3), "
  59. .BR CURLOPT_HSTSREADFUNCTION "(3), "