docs/libcurl/opts/CURLOPT_HTTPPOST.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_HTTPPOST 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_HTTPPOST \- specify the multipart formpost content
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPOST,
  31                           struct curl_httppost *formpost);
  32 .SH DESCRIPTION
  33 Tells libcurl you want a multipart/formdata HTTP POST to be made and you
  34 instruct what data to pass on to the server in the \fIformpost\fP argument.
  35 Pass a pointer to a linked list of curl_httppost structs as parameter.  The
  36 easiest way to create such a list, is to use \fIcurl_formadd(3)\fP as
  37 documented. The data in this list must remain intact until you close this curl
  38 handle again with \fIcurl_easy_cleanup(3)\fP.
  39
  40 Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header.
  41 You can disable this header with \fICURLOPT_HTTPHEADER(3)\fP.
  42
  43 When setting \fICURLOPT_HTTPPOST(3)\fP, it will automatically set
  44 \fICURLOPT_NOBODY(3)\fP to 0.
  45 .SH DEFAULT
  46 NULL
  47 .SH PROTOCOLS
  48 HTTP
  49 .SH EXAMPLE
  50 .nf
  51 /* Fill in the file upload field. This makes libcurl load data from
  52    the given file name when curl_easy_perform() is called. */
  53 curl_formadd(&formpost,
  54              &lastptr,
  55              CURLFORM_COPYNAME, "sendfile",
  56              CURLFORM_FILE, "postit2.c",
  57              CURLFORM_END);
  58
  59 /* Fill in the filename field */
  60 curl_formadd(&formpost,
  61              &lastptr,
  62              CURLFORM_COPYNAME, "filename",
  63              CURLFORM_COPYCONTENTS, "postit2.c",
  64              CURLFORM_END);
  65
  66 /* Fill in the submit field too, even if this is rarely needed */
  67 curl_formadd(&formpost,
  68              &lastptr,
  69              CURLFORM_COPYNAME, "submit",
  70              CURLFORM_COPYCONTENTS, "send",
  71              CURLFORM_END);
  72 .fi
  73 .SH AVAILABILITY
  74 As long as HTTP is enabled
  75 .SH RETURN VALUE
  76 Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
  77 .SH "SEE ALSO"
  78 .BR CURLOPT_POSTFIELDS "(3), " CURLOPT_POST "(3), "