Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_NOPROGRESS.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_NOPROGRESS 3 "October 09, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_NOPROGRESS \- switch off the progress meter
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);
31: .SH DESCRIPTION
32: If \fIonoff\fP is to 1, it tells the library to shut off the progress meter
33: completely for requests done with this \fIhandle\fP. It will also prevent the
34: \fICURLOPT_XFERINFOFUNCTION(3)\fP or \fICURLOPT_PROGRESSFUNCTION(3)\fP from
35: getting called.
36: .SH DEFAULT
37: 1, meaning it normally runs without a progress meter.
38: .SH PROTOCOLS
39: All
40: .SH EXAMPLE
41: .nf
42: CURL *curl = curl_easy_init();
43: if(curl) {
44: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
45:
46: /* enable progress meter */
47: curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
48:
49: /* Perform the request */
50: curl_easy_perform(curl);
51: }
52: .fi
53: .SH AVAILABILITY
54: Always
55: .SH RETURN VALUE
56: Returns CURLE_OK.
57: .SH "SEE ALSO"
58: .BR CURLOPT_XFERINFOFUNCTION "(3), "
59: .BR CURLOPT_PROGRESSFUNCTION "(3), "
60: .BR CURLOPT_VERBOSE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>