plucky (3) CURLOPT_NOPROGRESS.3.gz

Provided by: libcurl4-doc_8.12.1-2ubuntu1_all bug

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(3) or CURLOPT_PROGRESSFUNCTION(3) 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(3) returns a CURLcode indicating success or error.

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

SEE ALSO

       CURLOPT_DEBUGFUNCTION(3), CURLOPT_PROGRESSFUNCTION(3), CURLOPT_VERBOSE(3), CURLOPT_XFERINFOFUNCTION(3)