CURLOPT_NOPROGRESS.3 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2017, 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_NOPROGRESS 3 "October 09, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_NOPROGRESS \- switch off the progress meter
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);
  29. .SH DESCRIPTION
  30. If \fIonoff\fP is to 1, it tells the library to shut off the progress meter
  31. completely for requests done with this \fIhandle\fP. It will also prevent the
  32. \fICURLOPT_XFERINFOFUNCTION(3)\fP or \fICURLOPT_PROGRESSFUNCTION(3)\fP from
  33. getting called.
  34. .SH DEFAULT
  35. 1, meaning it normally runs without a progress meter.
  36. .SH PROTOCOLS
  37. All
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  43. /* enable progress meter */
  44. curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
  45. /* Perform the request */
  46. curl_easy_perform(curl);
  47. }
  48. .fi
  49. .SH AVAILABILITY
  50. Always
  51. .SH RETURN VALUE
  52. Returns CURLE_OK.
  53. .SH "SEE ALSO"
  54. .BR CURLOPT_XFERINFOFUNCTION "(3), "
  55. .BR CURLOPT_PROGRESSFUNCTION "(3), "
  56. .BR CURLOPT_VERBOSE "(3), "