Blame view

3rdparty/curl/share/man/man3/CURLOPT_POSTREDIR.3 3.03 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
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2020, 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_POSTREDIR 3 "December 31, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_POSTREDIR \- how to act on an HTTP POST redirect
  .SH SYNOPSIS
  .nf
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTREDIR,
                            long bitmask);
  .SH DESCRIPTION
  Pass a bitmask to control how libcurl acts on redirects after POSTs that get a
  301, 302 or 303 response back.  A parameter with bit 0 set (value
  \fBCURL_REDIR_POST_301\fP) tells the library to respect RFC 7231 (section
  6.4.2 to 6.4.4) and not convert POST requests into GET requests when following
  a 301 redirection.  Setting bit 1 (value \fBCURL_REDIR_POST_302\fP) makes
  libcurl maintain the request method after a 302 redirect whilst setting bit 2
  (value \fBCURL_REDIR_POST_303\fP) makes libcurl maintain the request method
  after a 303 redirect. The value \fBCURL_REDIR_POST_ALL\fP is a convenience
  define that sets all three bits.
  
  The non-RFC behavior is ubiquitous in web browsers, so the library does the
  conversion by default to maintain consistency. However, a server may require a
  POST to remain a POST after such a redirection. This option is meaningful only
  when setting \fICURLOPT_FOLLOWLOCATION(3)\fP.
  .SH DEFAULT
  0
  .SH PROTOCOLS
  HTTP(S)
  .SH EXAMPLE
  .nf
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  
    /* a silly POST example */
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "data=true");
  
    /* example.com is redirected, so we tell libcurl to send POST on 301, 302 and
       303 HTTP response codes */
    curl_easy_setopt(curl, CURLOPT_POSTREDIR, CURL_REDIR_POST_ALL);
  
    curl_easy_perform(curl);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.17.1. This option was known as CURLOPT_POST301 up to 7.19.0 as it
  only supported the 301 then. CURL_REDIR_POST_303 was added in 7.26.0.
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  .SH "SEE ALSO"
  .BR CURLOPT_FOLLOWLOCATION "(3), " CURLOPT_POSTFIELDS "(3), "