docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, 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_COPYPOSTFIELDS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_COPYPOSTFIELDS \- have libcurl copy data to POST
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COPYPOSTFIELDS, char *data);
  30 .SH DESCRIPTION
  31 Pass a char * as parameter, which should be the full \fIdata\fP to post in a
  32 HTTP POST operation. It behaves as the \fICURLOPT_POSTFIELDS(3)\fP option, but
  33 the original data is instead copied by the library, allowing the application
  34 to overwrite the original data after setting this option.
  35
  36 Because data are copied, care must be taken when using this option in
  37 conjunction with \fICURLOPT_POSTFIELDSIZE(3)\fP or
  38 \fICURLOPT_POSTFIELDSIZE_LARGE(3)\fP: If the size has not been set prior to
  39 \fICURLOPT_COPYPOSTFIELDS(3)\fP, the data is assumed to be a zero terminated
  40 string; else the stored size informs the library about the byte count to
  41 copy. In any case, the size must not be changed after
  42 \fICURLOPT_COPYPOSTFIELDS(3)\fP, unless another \fICURLOPT_POSTFIELDS(3)\fP or
  43 \fICURLOPT_COPYPOSTFIELDS(3)\fP option is issued.
  44 .SH DEFAULT
  45 NULL
  46 .SH PROTOCOLS
  47 HTTP(S)
  48 .SH EXAMPLE
  49 .nf
  50 CURL *curl = curl_easy_init();
  51 if(curl) {
  52   char local_buffer[1024]="data to send";
  53   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  54
  55   /* size of the data to copy from the buffer and send in the request */
  56   curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, 12L);
  57
  58   /* send data from the local stack */
  59   curl_easy_setopt(curl, CURLOPT_COPYPOSTFIELDS, local_buffer);
  60
  61   curl_easy_perform(curl);
  62 }
  63 .fi
  64 .SH AVAILABILITY
  65 Added in 7.17.1
  66 .SH RETURN VALUE
  67 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  68 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  69 .SH "SEE ALSO"
  70 .BR CURLOPT_POSTFIELDS "(3), " CURLOPT_POSTFIELDSIZE "(3), "