123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * This software is licensed as described in the file COPYING, which
- .\" * you should have received as part of this distribution. The terms
- .\" * are also available at https://curl.se/docs/copyright.html.
- .\" *
- .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- .\" * copies of the Software, and permit persons to whom the Software is
- .\" * furnished to do so, under the terms of the COPYING file.
- .\" *
- .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- .\" * KIND, either express or implied.
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLINFO_SIZE_DOWNLOAD 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
- .SH NAME
- CURLINFO_SIZE_DOWNLOAD \- get the number of downloaded bytes
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_DOWNLOAD, double *dlp);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a double to receive the total amount of bytes that were
- downloaded. The amount is only for the latest transfer and will be reset
- again for each new transfer. This counts actual payload data, what's also
- commonly called body. All meta and header data are excluded and will not be
- counted in this number.
- \fICURLINFO_SIZE_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
- sensible variable type.
- .SH PROTOCOLS
- All
- .SH EXAMPLE
- .nf
- CURL *curl = curl_easy_init();
- if(curl) {
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- /* Perform the request */
- res = curl_easy_perform(curl);
- if(!res) {
- /* check the size */
- double dl;
- res = curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD, &dl);
- if(!res) {
- printf("Downloaded %.0f bytes\\n", cl);
- }
- }
- }
- .fi
- .SH AVAILABILITY
- Added in 7.4.1
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH "SEE ALSO"
- .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
- .BR CURLINFO_SIZE_DOWNLOAD_T "(3), "
- .BR CURLINFO_SIZE_UPLOAD_T "(3), "
|