mirror of
https://codeberg.org/kiss-community/repo
synced 2025-01-05 01:10:07 -07:00
63 lines
2.1 KiB
Groff
63 lines
2.1 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_COPYPOSTFIELDS.md
|
|
.TH CURLOPT_COPYPOSTFIELDS 3 "2024-11-09" libcurl
|
|
.SH NAME
|
|
CURLOPT_COPYPOSTFIELDS \- have libcurl copy data to POST
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COPYPOSTFIELDS, char *data);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a char pointer 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 is 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 set.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
Using this option multiple times makes the last set string override the
|
|
previous ones. Set it to NULL to disable its use again.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
This functionality affects http only
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
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 curl 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_MIMEPOST (3),
|
|
.BR CURLOPT_POSTFIELDS (3),
|
|
.BR CURLOPT_POSTFIELDSIZE (3),
|
|
.BR CURLOPT_UPLOAD (3)
|