Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLINFO_SIZE_DOWNLOAD_T.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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 CURLINFO_SIZE_DOWNLOAD_T 3 "25 May 2017" "libcurl 7.55.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_SIZE_DOWNLOAD_T \- get the number of downloaded bytes
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_DOWNLOAD_T, curl_off_t *dlp);
30 .SH DESCRIPTION
31 Pass a pointer to a \fIcurl_off_t\fP to receive the total amount of bytes that
32 were downloaded. The amount is only for the latest transfer and will be reset
33 again for each new transfer. This counts actual payload data, what's also
34 commonly called body. All meta and header data are excluded and will not be
35 counted in this number.
36 .SH PROTOCOLS
37 All
38 .SH EXAMPLE
39 .nf
40 CURL *curl = curl_easy_init();
41 if(curl) {
42 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
43
44 /* Perform the request */
45 res = curl_easy_perform(curl);
46
47 if(!res) {
48 /* check the size */
49 curl_off_t dl;
50 res = curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD_T, &dl);
51 if(!res) {
52 printf("Downloaded %" CURL_FORMAT_CURL_OFF_T " bytes\\n", dl);
53 }
54 }
55 }
56 .fi
57 .SH AVAILABILITY
58 Added in 7.55.0
59 .SH RETURN VALUE
60 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
61 .SH "SEE ALSO"
62 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
63 .BR CURLINFO_SIZE_DOWNLOAD "(3), "
64 .BR CURLINFO_SIZE_UPLOAD_T "(3), "