curl_formget - serialize a previously built multipart/formdata HTTP POST chain
#include <curl/curl.h> int curl_formget(struct curl_httppost * form, void *userp, curl_formget_callback append );
curl_formget(3) libcurl Manual curl_formget(3)
NAME
curl_formget - serialize a previously built multipart/formdata HTTP
POST chain
SYNOPSIS
#include <curl/curl.h>
int curl_formget(struct curl_httppost * form, void *userp,
curl_formget_callback append );
DESCRIPTION
curl_formget() is used to serialize data previously built/appended with
curl_formadd(3). Accepts a void pointer as second argument named userp
which will be passed as the first argument to the curl_formget_callback
function.
typedef size_t (*curl_formget_callback)(void *userp, const char *buf,
size_t len);
The curl_formget_callback will be executed for each part of the HTTP
POST chain. The character buffer passed to the callback must not be
freed. The callback should return the buffer length passed to it on
success.
If the CURLFORM_STREAM option is used in the formpost, it will prevent
curl_formget(3) from working until you have performed the actual HTTP
request as only then will libcurl get the actual read callback to use!
EXAMPLE
size_t print_httppost_callback(void *arg, const char *buf, size_t len)
{
fwrite(buf, len, 1, stdout);
(*(size_t *) arg) += len;
return len;
}
size_t print_httppost(struct curl_httppost *post)
{
size_t total_size = 0;
if(curl_formget(post, &total_size, print_httppost_callback)) {
return (size_t) -1;
}
return total_size;
}
AVAILABILITY
This function was added in libcurl 7.15.5. The form API is deprecated
in libcurl 7.56.0.
RETURN VALUE
0 means everything was ok, non-zero means an error occurred
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | web/curl |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
curl_formadd(3), curl_mime_init(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://curl.se/down-
load/curl-7.83.1.tar.bz2.
Further information about this software can be found on the open source
community website at http://curl.haxx.se/.
libcurl 7.83.1 October 31, 2021 curl_formget(3)