curl / libcurl / API / curl_easy_setopt / CURLOPT_NOPROGRESS

CURLOPT_NOPROGRESS explained

Name

CURLOPT_NOPROGRESS - switch off the progress meter

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);

Description

If onoff is to 1, it tells the library to shut off the progress meter completely for requests done with this handle. It also prevents the CURLOPT_XFERINFOFUNCTION or CURLOPT_PROGRESSFUNCTION from getting called.

Default

1, meaning it normally runs without a progress meter.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
 
    /* enable progress meter */
    curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
 
    /* Perform the request */
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.1

Return value

curl_easy_setopt returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.