CURLOPT_PROGRESSDATA.3 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2014, 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.haxx.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_PROGRESSDATA 3 "February 03, 2016" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROGRESSDATA \- custom pointer passed to the progress callback
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROGRESSDATA, void *pointer);
  29. .SH DESCRIPTION
  30. Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
  31. argument in the progress callback set with \fICURLOPT_PROGRESSFUNCTION(3)\fP.
  32. .SH DEFAULT
  33. The default value of this parameter is NULL.
  34. .SH PROTOCOLS
  35. All
  36. .SH EXAMPLE
  37. https://curl.haxx.se/libcurl/c/progressfunc.html
  38. .SH AVAILABILITY
  39. Always
  40. .SH RETURN VALUE
  41. Returns CURLE_OK
  42. .SH "SEE ALSO"
  43. .BR CURLOPT_PROGRESSFUNCTION "(3), " CURLOPT_XFERINFOFUNCTION "(3), "