1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_NOPROGRESS
5Section: 3
6Source: libcurl
7See-also:
8  - CURLOPT_DEBUGFUNCTION (3)
9  - CURLOPT_PROGRESSFUNCTION (3)
10  - CURLOPT_VERBOSE (3)
11  - CURLOPT_XFERINFOFUNCTION (3)
12Protocol:
13  - All
14---
15
16# NAME
17
18CURLOPT_NOPROGRESS - switch off the progress meter
19
20# SYNOPSIS
21
22~~~c
23#include <curl/curl.h>
24
25CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);
26~~~
27
28# DESCRIPTION
29
30If *onoff* is to 1, it tells the library to shut off the progress meter
31completely for requests done with this *handle*. It also prevents the
32CURLOPT_XFERINFOFUNCTION(3) or CURLOPT_PROGRESSFUNCTION(3) from
33getting called.
34
35# DEFAULT
36
371, meaning it normally runs without a progress meter.
38
39# EXAMPLE
40
41~~~c
42int main(void)
43{
44  CURL *curl = curl_easy_init();
45  if(curl) {
46    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
47
48    /* enable progress meter */
49    curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
50
51    /* Perform the request */
52    curl_easy_perform(curl);
53  }
54}
55~~~
56
57# AVAILABILITY
58
59Always
60
61# RETURN VALUE
62
63Returns CURLE_OK.
64