CURLOPT_XFERINFODATA.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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_XFERINFODATA 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_XFERINFODATA \- pointer passed to the progress callback
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_XFERINFODATA, void *pointer);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
  33. argument in the progress callback set with \fICURLOPT_XFERINFOFUNCTION(3)\fP.
  34. This is an alias for \fICURLOPT_PROGRESSDATA(3)\fP.
  35. .SH DEFAULT
  36. The default value of this parameter is NULL.
  37. .SH PROTOCOLS
  38. All
  39. .SH EXAMPLE
  40. .nf
  41. struct progress {
  42. char *private;
  43. size_t size;
  44. };
  45. static size_t progress_callback(void *clientp,
  46. curl_off_t dltotal,
  47. curl_off_t dlnow,
  48. curl_off_t ultotal,
  49. curl_off_t ulnow)
  50. {
  51. struct memory *progress = (struct progress *)userp;
  52. /* use the values */
  53. return 0; /* all is good */
  54. }
  55. struct progress data;
  56. /* pass struct to callback */
  57. curl_easy_setopt(curl_handle, CURLOPT_XFERINFODATA, &data);
  58. curl_easy_setopt(curl_handle, CURLOPT_XFERINFOFUNCTION, progress_callback);
  59. .fi
  60. .SH AVAILABILITY
  61. Added in 7.32.0
  62. .SH RETURN VALUE
  63. Returns CURLE_OK
  64. .SH "SEE ALSO"
  65. .BR CURLOPT_XFERINFOFUNCTION "(3), " CURLOPT_VERBOSE "(3), "