CMakeLua/Utilities/cmcurl-7.19.0/docs/libcurl/curl_formget.3

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