Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_HTTPPOST.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, 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 "September 02, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_HTTPPOST \- specify the multipart formpost content
27: .SH SYNOPSIS
28: .nf
29: #include <curl/curl.h>
30:
31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPOST,
32: struct curl_httppost *formpost);
33: .SH DESCRIPTION
34: Tells libcurl you want a multipart/formdata HTTP POST to be made and you
35: instruct what data to pass on to the server in the \fIformpost\fP argument.
36: Pass a pointer to a linked list of curl_httppost structs as parameter. The
37: easiest way to create such a list, is to use \fIcurl_formadd(3)\fP as
38: documented. The data in this list must remain intact as long as the curl
39: transfer is alive and is using it.
40:
41: Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header.
42: You can disable this header with \fICURLOPT_HTTPHEADER(3)\fP.
43:
44: When setting \fICURLOPT_HTTPPOST(3)\fP, it will automatically set
45: \fICURLOPT_NOBODY(3)\fP to 0.
46:
47: This option is deprecated! Do not use it. Use \fICURLOPT_MIMEPOST(3)\fP
48: instead after having prepared mime data.
49: .SH DEFAULT
50: NULL
51: .SH PROTOCOLS
52: HTTP
53: .SH EXAMPLE
54: .nf
55: /* Fill in the file upload field. This makes libcurl load data from
56: the given file name when curl_easy_perform() is called. */
57: curl_formadd(&formpost,
58: &lastptr,
59: CURLFORM_COPYNAME, "sendfile",
60: CURLFORM_FILE, "postit2.c",
61: CURLFORM_END);
62:
63: /* Fill in the filename field */
64: curl_formadd(&formpost,
65: &lastptr,
66: CURLFORM_COPYNAME, "filename",
67: CURLFORM_COPYCONTENTS, "postit2.c",
68: CURLFORM_END);
69:
70: /* Fill in the submit field too, even if this is rarely needed */
71: curl_formadd(&formpost,
72: &lastptr,
73: CURLFORM_COPYNAME, "submit",
74: CURLFORM_COPYCONTENTS, "send",
75: CURLFORM_END);
76: .fi
77: .SH AVAILABILITY
78: As long as HTTP is enabled. Deprecated in 7.56.0.
79: .SH RETURN VALUE
80: Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
81: .SH "SEE ALSO"
82: .BR CURLOPT_POSTFIELDS "(3), " CURLOPT_POST "(3), " CURLOPT_MIMEPOST "(3),"
83: .BR curl_formadd "(3), " curl_formfree "(3), " curl_mime_init "(3)"
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>