| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, 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_POSTFIELDS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_POSTFIELDS \- specify data to POST to server |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTFIELDS, char *postdata); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a char * as parameter, pointing to the full data to send in an HTTP POST |
| 32 |
operation. You must make sure that the data is formatted the way you want the |
| 33 |
server to receive it. libcurl will not convert or encode it for you in any |
| 34 |
way. For example, the web server may assume that this data is url-encoded. |
| 35 |
|
| 36 |
The data pointed to is NOT copied by the library: as a consequence, it must be |
| 37 |
preserved by the calling application until the associated transfer finishes. |
| 38 |
This behaviour can be changed (so libcurl does copy the data) by setting the |
| 39 |
\fICURLOPT_COPYPOSTFIELDS(3)\fP option. |
| 40 |
|
| 41 |
This POST is a normal application/x-www-form-urlencoded kind (and libcurl will |
| 42 |
set that Content-Type by default when this option is used), which is commonly |
| 43 |
used by HTML forms. Change Content-Type with \fICURLOPT_HTTPHEADER(3)\fP. |
| 44 |
|
| 45 |
You can use \fIcurl_easy_escape(3)\fP to url-encode your data, if necessary. It |
| 46 |
returns a pointer to an encoded string that can be passed as \fIpostdata\fP. |
| 47 |
|
| 48 |
Using \fICURLOPT_POSTFIELDS(3)\fP implies setting \fICURLOPT_POST(3)\fP to 1. |
| 49 |
|
| 50 |
If \fICURLOPT_POSTFIELDS(3)\fP is explicitly set to NULL then libcurl will get |
| 51 |
the POST data from the read callback. If you want to send a zero-byte POST set |
| 52 |
\fICURLOPT_POSTFIELDS(3)\fP to an empty string, or set \fICURLOPT_POST(3)\fP to |
| 53 |
1 and \fICURLOPT_POSTFIELDSIZE(3)\fP to 0. |
| 54 |
|
| 55 |
Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header, |
| 56 |
and libcurl will add that header automatically if the POST is either known to |
| 57 |
be larger than 1MB or if the expected size is unknown. You can disable this |
| 58 |
header with \fICURLOPT_HTTPHEADER(3)\fP as usual. |
| 59 |
|
| 60 |
To make multipart/formdata posts (aka RFC2388-posts), check out the |
| 61 |
\fICURLOPT_HTTPPOST(3)\fP option combined with \fIcurl_formadd(3)\fP. |
| 62 |
.SH DEFAULT |
| 63 |
NULL |
| 64 |
.SH PROTOCOLS |
| 65 |
HTTP |
| 66 |
.SH EXAMPLE |
| 67 |
.nf |
| 68 |
CURL *curl = curl_easy_init(); |
| 69 |
if(curl) { |
| 70 |
const char *data = "data to send"; |
| 71 |
|
| 72 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| 73 |
|
| 74 |
/* size of the POST data */ |
| 75 |
curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, 12L); |
| 76 |
|
| 77 |
/* pass in a pointer to the data - libcurl will not copy */ |
| 78 |
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data); |
| 79 |
|
| 80 |
curl_easy_perform(curl); |
| 81 |
} |
| 82 |
.fi |
| 83 |
.SH AVAILABILITY |
| 84 |
Always |
| 85 |
.SH RETURN VALUE |
| 86 |
Returns CURLE_OK |
| 87 |
.SH "SEE ALSO" |
| 88 |
.BR CURLOPT_POSTFIELDSIZE "(3), " CURLOPT_READFUNCTION "(3), " |