curl_formget.html 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. <html><head>
  2. <title>curl_formget man page</title>
  3. <meta name="generator" content="roffit 0.7">
  4. <STYLE type="text/css">
  5. P.level0 {
  6. padding-left: 2em;
  7. }
  8. P.level1 {
  9. padding-left: 4em;
  10. }
  11. P.level2 {
  12. padding-left: 6em;
  13. }
  14. span.emphasis {
  15. font-style: italic;
  16. }
  17. span.bold {
  18. font-weight: bold;
  19. }
  20. span.manpage {
  21. font-weight: bold;
  22. }
  23. h2.nroffsh {
  24. background-color: #e0e0e0;
  25. }
  26. span.nroffip {
  27. font-weight: bold;
  28. font-size: 120%;
  29. font-family: monospace;
  30. }
  31. p.roffit {
  32. text-align: center;
  33. font-size: 80%;
  34. }
  35. </STYLE>
  36. </head><body>
  37. <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  38. <p class="level0">curl_formget - serialize a previously build multipart/formdata HTTP POST chain <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  39. <p class="level0"><span Class="bold">#include &lt;curl/curl.h&gt;</span>
  40. <p class="level0"><span Class="bold">void curl_formget(struct curl_httppost * form, void * arg,</span> <span Class="bold"> curl_formget_callback append );</span>
  41. <p class="level0"><a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  42. <p class="level0">curl_formget() is used to serialize data previously built/appended with <a class="emphasis" href="./curl_formadd.html">curl_formadd(3)</a>. Accepts a void pointer as second argument which will be passed to the curl_formget_callback function.
  43. <p class="level0"><span Class="bold">typedef size_t (*curl_formget_callback)(void * arg, const char * buf,</span> <span Class="bold"> size_t len );</span> <pre>
  44. <p class="level0"><p class="level0">The curl_formget_callback will be executed for each part of the HTTP POST
  45. chain. The void *arg pointer will be the one passed as second argument to
  46. curl_formget(). The character buffer passed to it must not be freed. The
  47. callback should return the buffer length passed to it on success.
  48. </pre>
  49. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  50. <p class="level0">0 means everything was ok, non-zero means an error occurred <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  51. <p class="level0"><pre>
  52. <p class="level0"><p class="level0">&nbsp;size_t print_httppost_callback(void *arg, const char *buf, size_t len)
  53. &nbsp;{
  54. &nbsp; fwrite(buf, len, 1, stdout);
  55. &nbsp; (*(size_t *) arg) += len;
  56. &nbsp; return len;
  57. &nbsp;}
  58. &nbsp;size_t print_httppost(struct curl_httppost *post)
  59. &nbsp;{
  60. &nbsp; size_t total_size = 0;
  61. &nbsp; if(curl_formget(post, &total_size, print_httppost_callback)) {
  62. &nbsp; return (size_t) -1;
  63. &nbsp; }
  64. &nbsp; return total_size;
  65. &nbsp;}
  66. </pre>
  67. <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  68. <p class="level0">This function was added in libcurl 7.15.5 <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  69. <p class="level0"><a class="manpage" href="./curl_formadd.html">curl_formadd (3) </a> <p class="roffit">
  70. This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  71. </body></html>