xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_NOPROGRESS.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_NOPROGRESS
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_DEBUGFUNCTION (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_PROGRESSFUNCTION (3)
10*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_VERBOSE (3)
11*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_XFERINFOFUNCTION (3)
12*6236dae4SAndroid Build Coastguard WorkerProtocol:
13*6236dae4SAndroid Build Coastguard Worker  - All
14*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.1
15*6236dae4SAndroid Build Coastguard Worker---
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard Worker# NAME
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard WorkerCURLOPT_NOPROGRESS - switch off the progress meter
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Worker~~~c
24*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);
27*6236dae4SAndroid Build Coastguard Worker~~~
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard WorkerIf *onoff* is to 1, it tells the library to shut off the progress meter
32*6236dae4SAndroid Build Coastguard Workercompletely for requests done with this *handle*. It also prevents the
33*6236dae4SAndroid Build Coastguard WorkerCURLOPT_XFERINFOFUNCTION(3) or CURLOPT_PROGRESSFUNCTION(3) from
34*6236dae4SAndroid Build Coastguard Workergetting called.
35*6236dae4SAndroid Build Coastguard Worker
36*6236dae4SAndroid Build Coastguard Worker# DEFAULT
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard Worker1, meaning it normally runs without a progress meter.
39*6236dae4SAndroid Build Coastguard Worker
40*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
41*6236dae4SAndroid Build Coastguard Worker
42*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
43*6236dae4SAndroid Build Coastguard Worker
44*6236dae4SAndroid Build Coastguard Worker~~~c
45*6236dae4SAndroid Build Coastguard Workerint main(void)
46*6236dae4SAndroid Build Coastguard Worker{
47*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
48*6236dae4SAndroid Build Coastguard Worker  if(curl) {
49*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
50*6236dae4SAndroid Build Coastguard Worker
51*6236dae4SAndroid Build Coastguard Worker    /* enable progress meter */
52*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
53*6236dae4SAndroid Build Coastguard Worker
54*6236dae4SAndroid Build Coastguard Worker    /* Perform the request */
55*6236dae4SAndroid Build Coastguard Worker    curl_easy_perform(curl);
56*6236dae4SAndroid Build Coastguard Worker  }
57*6236dae4SAndroid Build Coastguard Worker}
58*6236dae4SAndroid Build Coastguard Worker~~~
59*6236dae4SAndroid Build Coastguard Worker
60*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
61*6236dae4SAndroid Build Coastguard Worker
62*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
63*6236dae4SAndroid Build Coastguard Worker
64*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK.
65