Blame view

3rdparty/curl/share/man/man3/CURLOPT_COPYPOSTFIELDS.3 2.86 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
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  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_COPYPOSTFIELDS 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_COPYPOSTFIELDS \- have libcurl copy data to POST
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COPYPOSTFIELDS, char *data);
  .SH DESCRIPTION
  Pass a char * as parameter, which should be the full \fIdata\fP to post in a
  HTTP POST operation. It behaves as the \fICURLOPT_POSTFIELDS(3)\fP option, but
  the original data is instead copied by the library, allowing the application
  to overwrite the original data after setting this option.
  
  Because data are copied, care must be taken when using this option in
  conjunction with \fICURLOPT_POSTFIELDSIZE(3)\fP or
  \fICURLOPT_POSTFIELDSIZE_LARGE(3)\fP: If the size has not been set prior to
  \fICURLOPT_COPYPOSTFIELDS(3)\fP, the data is assumed to be a null-terminated
  string; else the stored size informs the library about the byte count to
  copy. In any case, the size must not be changed after
  \fICURLOPT_COPYPOSTFIELDS(3)\fP, unless another \fICURLOPT_POSTFIELDS(3)\fP or
  \fICURLOPT_COPYPOSTFIELDS(3)\fP option is issued.
  .SH DEFAULT
  NULL
  .SH PROTOCOLS
  HTTP(S)
  .SH EXAMPLE
  .nf
  CURL *curl = curl_easy_init();
  if(curl) {
    char local_buffer[1024]="data to send";
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  
    /* size of the data to copy from the buffer and send in the request */
    curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, 12L);
  
    /* send data from the local stack */
    curl_easy_setopt(curl, CURLOPT_COPYPOSTFIELDS, local_buffer);
  
    curl_easy_perform(curl);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.17.1
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  .SH "SEE ALSO"
  .BR CURLOPT_POSTFIELDS "(3), " CURLOPT_POSTFIELDSIZE "(3), "