mirror of
https://github.com/moparisthebest/curl
synced 2024-12-24 00:58:48 -05:00
83 lines
3.2 KiB
Groff
83 lines
3.2 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_HTTPPOST 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_HTTPPOST \- specify the multipart formpost content
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPOST,
|
|
struct curl_httppost *formpost);
|
|
.SH 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 \fIformpost\fP 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 \fIcurl_formadd(3)\fP 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 \fICURLOPT_HTTPHEADER(3)\fP.
|
|
|
|
When setting \fICURLOPT_HTTPPOST(3)\fP, it will automatically set
|
|
\fICURLOPT_NOBODY(3)\fP to 0.
|
|
|
|
This option is deprecated! Do not use it. Use \fICURLOPT_MIMEPOST(3)\fP
|
|
instead after having prepared mime data.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
HTTP
|
|
.SH EXAMPLE
|
|
.nf
|
|
/* 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);
|
|
.fi
|
|
.SH AVAILABILITY
|
|
As long as HTTP is enabled. Deprecated in 7.56.0.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_POSTFIELDS "(3), " CURLOPT_POST "(3), " CURLOPT_MIMEPOST "(3),"
|
|
.BR curl_formadd "(3), " curl_formfree "(3), " curl_mime_init "(3)"
|