| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- .\" generated by cd2nroff 0.1 from CURLOPT_PROXYHEADER.md
- .TH CURLOPT_PROXYHEADER 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_PROXYHEADER \- set of HTTP headers to pass to proxy
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYHEADER,
- struct curl_slist *headers);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a linked list of HTTP headers to pass in your HTTP request
- sent to a proxy. The rules for this list is identical to the
- \fICURLOPT_HTTPHEADER(3)\fP option\(aqs.
- The headers set with this option is only ever used in requests sent to a proxy
- - when there is also a request sent to a host.
- The first line in a request (containing the method, usually a GET or POST) is
- NOT a header and cannot be replaced using this option. Only the lines
- following the request\-line are headers. Adding this method line in this list
- of headers causes your request to send an invalid header.
- Pass a NULL to this to reset back to no custom headers.
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- struct curl_slist *list;
- if(curl) {
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy.example.com:80");
- list = curl_slist_append(NULL, "Shoesize: 10");
- list = curl_slist_append(list, "Accept:");
- curl_easy_setopt(curl, CURLOPT_PROXYHEADER, list);
- curl_easy_perform(curl);
- curl_slist_free_all(list); /* free the list again */
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.37.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_HEADEROPT (3),
- .BR CURLOPT_HTTPHEADER (3)
|