Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_HTTPPOST (3)

Name

CURLOPT_HTTPPOST - specify the multipart formpost content

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPOST,
struct curl_httppost *formpost);

Description

CURLOPT_HTTPPOST(3)        curl_easy_setopt options        CURLOPT_HTTPPOST(3)



NAME
       CURLOPT_HTTPPOST - specify the multipart formpost content

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPOST,
                                 struct curl_httppost *formpost);

DESCRIPTION
       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  formpost  argu-
       ment.   Pass  a  pointer  to  a linked list of curl_httppost structs as
       parameter.  The easiest way to create such a list, is to use  curl_for-
       madd(3) as documented. The data in this list must remain intact as long
       as the curl transfer is alive and is using it.

       Using POST with HTTP 1.1 implies the use of  a  "Expect:  100-continue"
       header.  You can disable this header with CURLOPT_HTTPHEADER(3).

       When  setting  CURLOPT_HTTPPOST(3),  it  will  automatically  set  CUR-
       LOPT_NOBODY(3) to 0.

       This option is deprecated!  Do  not  use  it.  Use  CURLOPT_MIMEPOST(3)
       instead after having prepared mime data.

DEFAULT
       NULL

PROTOCOLS
       HTTP

EXAMPLE
       /* Fill in the file upload field. This makes libcurl load data from
          the given file name when curl_easy_perform() is called. */
       curl_formadd(&formpost,
                    &lastptr,
                    CURLFORM_COPYNAME, "sendfile",
                    CURLFORM_FILE, "postit2.c",
                    CURLFORM_END);

       /* Fill in the filename field */
       curl_formadd(&formpost,
                    &lastptr,
                    CURLFORM_COPYNAME, "filename",
                    CURLFORM_COPYCONTENTS, "postit2.c",
                    CURLFORM_END);

       /* Fill in the submit field too, even if this is rarely needed */
       curl_formadd(&formpost,
                    &lastptr,
                    CURLFORM_COPYNAME, "submit",
                    CURLFORM_COPYCONTENTS, "send",
                    CURLFORM_END);

AVAILABILITY
       As long as HTTP is enabled. Deprecated in 7.56.0.

RETURN VALUE
       Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_POSTFIELDS(3),  CURLOPT_POST(3), CURLOPT_MIMEPOST(3), curl_for-
       madd(3), curl_formfree(3), curl_mime_init(3)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    17 Jun 2014              CURLOPT_HTTPPOST(3)