docs/libcurl/opts/CURLOPT_POSTFIELDS.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 http://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 a 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 Using \fICURLOPT_POSTFIELDS(3)\fP implies \fICURLOPT_POST(3)\fP.
  46
  47 You can use \fIcurl_easy_escape(3)\fP to url-encode your data, if necessary. It
  48 returns a pointer to an encoded string that can be passed as \fIpostdata\fP.
  49
  50 If you want to do a zero-byte POST, you need to set
  51 \fICURLOPT_POSTFIELDSIZE(3)\fP explicitly to zero, as simply setting
  52 \fICURLOPT_POSTFIELDS(3)\fP to NULL or "" just effectively disables the
  53 sending of the specified string. libcurl will instead assume that you'll send
  54 the POST data using the read callback!
  55
  56 Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header.
  57 You can disable this header with \fICURLOPT_HTTPHEADER(3)\fP as usual.
  58
  59 To make multipart/formdata posts (aka RFC2388-posts), check out the
  60 \fICURLOPT_HTTPPOST(3)\fP option combined with \fIcurl_formadd(3)\fP.
  61 .SH DEFAULT
  62 NULL
  63 .SH PROTOCOLS
  64 HTTP
  65 .SH EXAMPLE
  66 .nf
  67 CURL *curl = curl_easy_init();
  68 if(curl) {
  69   const char *data = "data to send";
  70
  71   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  72
  73   /* size of the POST data */
  74   curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, 12L);
  75
  76   /* pass in a pointer to the data - libcurl will not copy */
  77   curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
  78
  79   curl_easy_perform(curl);
  80 }
  81 .fi
  82 .SH AVAILABILITY
  83 Always
  84 .SH RETURN VALUE
  85 Returns CURLE_OK
  86 .SH "SEE ALSO"
  87 .BR CURLOPT_POSTFIELDSIZE "(3), " CURLOPT_READFUNCTION "(3), "