docs/libcurl/opts/CURLOPT_HTTPPOST.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_HTTPPOST man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 P.level0 {
   8  padding-left: 2em;
   9 }
  10
  11 P.level1 {
  12  padding-left: 4em;
  13 }
  14
  15 P.level2 {
  16  padding-left: 6em;
  17 }
  18
  19 span.emphasis {
  20  font-style: italic;
  21 }
  22
  23 span.bold {
  24  font-weight: bold;
  25 }
  26
  27 span.manpage {
  28  font-weight: bold;
  29 }
  30
  31 h2.nroffsh {
  32  background-color: #e0e0e0;
  33 }
  34
  35 span.nroffip {
  36  font-weight: bold;
  37  font-size: 120%;
  38  font-family: monospace;
  39 }
  40
  41 p.roffit {
  42  text-align: center;
  43  font-size: 80%;
  44 }
  45 </STYLE>
  46 </head><body>
  47
  48 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  49 <p class="level0">CURLOPT_HTTPPOST - specify the multipart formpost content <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  50 <p class="level0"><pre>
  51 <p class="level0">#include &lt;curl/curl.h&gt;
  52  <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPOST,
  53  &nbsp;                         struct curl_httppost *formpost);
  54  </pre>
  55 <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  56 <p class="level0">Tells libcurl you want a multipart/formdata HTTP POST to be made and you instruct what data to pass on to the server in the <span Class="emphasis">formpost</span> argument. Pass a pointer to a linked list of curl_httppost structs as parameter.  The easiest way to create such a list, is to use <span Class="emphasis">curl_formadd(3)</span> as documented. The data in this list must remain intact until you close this curl handle again with <span Class="emphasis">curl_easy_cleanup(3)</span>.
  57 <p class="level0">Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header. You can disable this header with <a Class="emphasis" href="./CURLOPT_HTTPHEADER.html">CURLOPT_HTTPHEADER</a>.
  58 <p class="level0">When setting <a Class="emphasis" href="./CURLOPT_HTTPPOST.html">CURLOPT_HTTPPOST</a>, it will automatically set <a Class="emphasis" href="./CURLOPT_NOBODY.html">CURLOPT_NOBODY</a> to 0. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  59 <p class="level0">NULL <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  60 <p class="level0">HTTP <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  61 <p class="level0"><pre>
  62 <p class="level0">/* Fill in the file upload field. This makes libcurl load data from
  63  &nbsp;  the given file name when curl_easy_perform() is called. */
  64  curl_formadd(&formpost,
  65  &nbsp;            &lastptr,
  66  &nbsp;            CURLFORM_COPYNAME, "sendfile",
  67  &nbsp;            CURLFORM_FILE, "postit2.c",
  68  &nbsp;            CURLFORM_END);
  69  <p class="level0">/* Fill in the filename field */
  70  curl_formadd(&formpost,
  71  &nbsp;            &lastptr,
  72  &nbsp;            CURLFORM_COPYNAME, "filename",
  73  &nbsp;            CURLFORM_COPYCONTENTS, "postit2.c",
  74  &nbsp;            CURLFORM_END);
  75  <p class="level0">/* Fill in the submit field too, even if this is rarely needed */
  76  curl_formadd(&formpost,
  77  &nbsp;            &lastptr,
  78  &nbsp;            CURLFORM_COPYNAME, "submit",
  79  &nbsp;            CURLFORM_COPYCONTENTS, "send",
  80  &nbsp;            CURLFORM_END);
  81  </pre>
  82
  83 <p class="level0"><a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  84 <p class="level0">As long as HTTP is enabled <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  85 <p class="level0">Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  86 <p class="level0"><a Class="manpage" href="./CURLOPT_POSTFIELDS.html">CURLOPT_POSTFIELDS</a>, <a Class="manpage" href="./CURLOPT_POST.html">CURLOPT_POST</a>, <span Class="manpage"> </span> <p class="roffit">
  87  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  88 </body></html>