| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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_PROXYHEADER 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_PROXYHEADER \- custom HTTP headers to pass to proxy |
| 26 |
.SH SYNOPSIS |
| 27 |
.nf |
| 28 |
#include <curl/curl.h> |
| 29 |
|
| 30 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYHEADER, |
| 31 |
struct curl_slist *headers); |
| 32 |
.SH DESCRIPTION |
| 33 |
Pass a pointer to a linked list of HTTP headers to pass in your HTTP request |
| 34 |
sent to a proxy. The rules for this list is identical to the |
| 35 |
\fICURLOPT_HTTPHEADER(3)\fP option's. |
| 36 |
|
| 37 |
The headers set with this option is only ever used in requests sent to a proxy |
| 38 |
- when there's also a request sent to a host. |
| 39 |
|
| 40 |
The first line in a request (containing the method, usually a GET or POST) is |
| 41 |
NOT a header and cannot be replaced using this option. Only the lines |
| 42 |
following the request-line are headers. Adding this method line in this list |
| 43 |
of headers will only cause your request to send an invalid header. |
| 44 |
|
| 45 |
Pass a NULL to this to reset back to no custom headers. |
| 46 |
.SH DEFAULT |
| 47 |
NULL |
| 48 |
.SH PROTOCOLS |
| 49 |
HTTP |
| 50 |
.SH EXAMPLE |
| 51 |
.nf |
| 52 |
CURL *curl = curl_easy_init(); |
| 53 |
|
| 54 |
struct curl_slist *list; |
| 55 |
|
| 56 |
if(curl) { |
| 57 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); |
| 58 |
curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy.example.com:80"); |
| 59 |
|
| 60 |
list = curl_slist_append(NULL, "Shoesize: 10"); |
| 61 |
list = curl_slist_append(list, "Accept:"); |
| 62 |
|
| 63 |
curl_easy_setopt(curl, CURLOPT_PROXYHEADER, list); |
| 64 |
|
| 65 |
curl_easy_perform(curl); |
| 66 |
|
| 67 |
curl_slist_free_all(list); /* free the list again */ |
| 68 |
} |
| 69 |
.fi |
| 70 |
.SH AVAILABILITY |
| 71 |
Added in 7.37.0 |
| 72 |
.SH RETURN VALUE |
| 73 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 74 |
.SH "SEE ALSO" |
| 75 |
.BR CURLOPT_HEADEROPT "(3), " CURLOPT_HTTPHEADER "(3), " |