71 lines
2.9 KiB
Groff
71 lines
2.9 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) 1998 - 2014, 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.haxx.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 "19 Jun 2014" "libcurl 7.37.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 zero 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, "http://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), "
|