Blame view

3rdparty/curl/share/man/man3/CURLOPT_PROXYHEADER.3 2.7 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_PROXYHEADER 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_PROXYHEADER \- custom 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);
  .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's.
  
  The headers set with this option is only ever used in requests sent to a proxy
  - when there's 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 will only cause your request to send an invalid header.
  
  Pass a NULL to this to reset back to no custom headers.
  .SH DEFAULT
  NULL
  .SH PROTOCOLS
  HTTP
  .SH EXAMPLE
  .nf
  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 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), " CURLOPT_HTTPHEADER "(3), "