mingw/share/man/man3/curl_formget.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\"
   4 .TH curl_formget 3 "20 June 2006" "libcurl 7.15.5" "libcurl Manual"
   5 .SH NAME
   6 curl_formget - serialize a previously built multipart/formdata HTTP POST chain
   7 .SH SYNOPSIS
   8 .B #include <curl/curl.h>
   9 .sp
  10 .BI "void curl_formget(struct curl_httppost *" form, " void *" arg,
  11 .BI " curl_formget_callback " append ");"
  12 .ad
  13 .SH DESCRIPTION
  14 curl_formget() is used to serialize data previously built/appended with
  15 \fIcurl_formadd(3)\fP. Accepts a void pointer as second argument which will be
  16 passed to the curl_formget_callback function.
  17
  18 .BI "typedef size_t (*curl_formget_callback)(void *" arg, " const char *" buf,
  19 .BI " size_t " len ");"
  20 .nf
  21
  22 The curl_formget_callback will be executed for each part of the HTTP POST
  23 chain. The void *arg pointer will be the one passed as second argument to
  24 curl_formget(). The character buffer passed to it must not be freed. The
  25 callback should return the buffer length passed to it on success.
  26 .SH RETURN VALUE
  27 0 means everything was ok, non-zero means an error occurred
  28 .SH EXAMPLE
  29 .nf
  30
  31  size_t print_httppost_callback(void *arg, const char *buf, size_t len)
  32  {
  33    fwrite(buf, len, 1, stdout);
  34    (*(size_t *) arg) += len;
  35    return len;
  36  }
  37  size_t print_httppost(struct curl_httppost *post)
  38  {
  39    size_t total_size = 0;
  40    if(curl_formget(post, &total_size, print_httppost_callback)) {
  41      return (size_t) -1;
  42    }
  43    return total_size;
  44  }
  45 .SH AVAILABILITY
  46 This function was added in libcurl 7.15.5
  47 .SH "SEE ALSO"
  48 .BR curl_formadd "(3) "