CURLOPT_HEADEROPT.3 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2017, 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.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_HEADEROPT 3 "April 17, 2018" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_HEADEROPT \- set how to send HTTP headers
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADEROPT, long bitmask);
  29. .SH DESCRIPTION
  30. Pass a long that is a bitmask of options of how to deal with headers. The two
  31. mutually exclusive options are:
  32. \fBCURLHEADER_UNIFIED\fP - the headers specified in
  33. \fICURLOPT_HTTPHEADER(3)\fP will be used in requests both to servers and
  34. proxies. With this option enabled, \fICURLOPT_PROXYHEADER(3)\fP will not have
  35. any effect.
  36. \fBCURLHEADER_SEPARATE\fP - makes \fICURLOPT_HTTPHEADER(3)\fP headers only get
  37. sent to a server and not to a proxy. Proxy headers must be set with
  38. \fICURLOPT_PROXYHEADER(3)\fP to get used. Note that if a non-CONNECT request
  39. is sent to a proxy, libcurl will send both server headers and proxy
  40. headers. When doing CONNECT, libcurl will send \fICURLOPT_PROXYHEADER(3)\fP
  41. headers only to the proxy and then \fICURLOPT_HTTPHEADER(3)\fP headers only to
  42. the server.
  43. .SH DEFAULT
  44. CURLHEADER_SEPARATE (changed in 7.42.1, used CURLHEADER_UNIFIED before then)
  45. .SH PROTOCOLS
  46. HTTP
  47. .SH EXAMPLE
  48. .nf
  49. CURL *curl = curl_easy_init();
  50. if(curl) {
  51. CURLcode ret;
  52. struct curl_slist *list;
  53. list = curl_slist_append(NULL, "Shoesize: 10");
  54. list = curl_slist_append(list, "Accept:");
  55. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  56. curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");
  57. /* HTTPS over a proxy makes a separate CONNECT to the proxy, so tell
  58. libcurl to not send the custom headers to the proxy. Keep them
  59. separate! */
  60. curl_easy_setopt(curl, CURLOPT_HEADEROPT, CURLHEADER_SEPARATE);
  61. ret = curl_easy_perform(curl);
  62. curl_easy_cleanup(curl);
  63. }
  64. .fi
  65. .SH AVAILABILITY
  66. Added in 7.37.0
  67. .SH RETURN VALUE
  68. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  69. .SH "SEE ALSO"
  70. .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_PROXYHEADER "(3), "