CURLOPT_NOPROGRESS.3 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. .\" generated by cd2nroff 0.1 from CURLOPT_NOPROGRESS.md
  2. .TH CURLOPT_NOPROGRESS 3 "2025-01-17" libcurl
  3. .SH NAME
  4. CURLOPT_NOPROGRESS \- switch off the progress meter
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);
  9. .fi
  10. .SH DESCRIPTION
  11. If \fIonoff\fP is to 1, it tells the library to shut off the progress meter
  12. completely for requests done with this \fIhandle\fP. It also prevents the
  13. \fICURLOPT_XFERINFOFUNCTION(3)\fP or \fICURLOPT_PROGRESSFUNCTION(3)\fP from
  14. getting called.
  15. .SH DEFAULT
  16. 1, meaning it normally runs without a progress meter.
  17. .SH PROTOCOLS
  18. This functionality affects all supported protocols
  19. .SH EXAMPLE
  20. .nf
  21. int main(void)
  22. {
  23. CURL *curl = curl_easy_init();
  24. if(curl) {
  25. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  26. /* enable progress meter */
  27. curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
  28. /* Perform the request */
  29. curl_easy_perform(curl);
  30. }
  31. }
  32. .fi
  33. .SH AVAILABILITY
  34. Added in curl 7.1
  35. .SH RETURN VALUE
  36. Returns CURLE_OK.
  37. .SH SEE ALSO
  38. .BR CURLOPT_DEBUGFUNCTION (3),
  39. .BR CURLOPT_PROGRESSFUNCTION (3),
  40. .BR CURLOPT_VERBOSE (3),
  41. .BR CURLOPT_XFERINFOFUNCTION (3)