curl/docs/libcurl/opts/CURLOPT_NOPROGRESS.md
Daniel Stenberg e3fe020089
docs/libcurl: generate PROTOCOLS from meta-data
Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175
2024-03-23 18:13:03 +01:00

1.1 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLOPT_NOPROGRESS 3 libcurl
CURLOPT_DEBUGFUNCTION (3)
CURLOPT_PROGRESSFUNCTION (3)
CURLOPT_VERBOSE (3)
CURLOPT_XFERINFOFUNCTION (3)
All

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.

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

Always

RETURN VALUE

Returns CURLE_OK.