Return to CURLINFO_SIZE_DOWNLOAD.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_SIZE_DOWNLOAD.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 CURLINFO_SIZE_DOWNLOAD 3 "June 15, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
                     24: 
                     25: .SH NAME
                     26: CURLINFO_SIZE_DOWNLOAD \- get the number of downloaded bytes
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_DOWNLOAD, double *dlp);
                     31: .SH DESCRIPTION
                     32: Pass a pointer to a double to receive the total amount of bytes that were
                     33: downloaded.  The amount is only for the latest transfer and will be reset
                     34: again for each new transfer. This counts actual payload data, what's also
                     35: commonly called body. All meta and header data are excluded and will not be
                     36: counted in this number.
                     37: 
                     38: \fICURLINFO_SIZE_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
                     39: sensible variable type.
                     40: .SH PROTOCOLS
                     41: All
                     42: .SH EXAMPLE
                     43: .nf
                     44: CURL *curl = curl_easy_init();
                     45: if(curl) {
                     46:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     47: 
                     48:   /* Perform the request */
                     49:   res = curl_easy_perform(curl);
                     50: 
                     51:   if(!res) {
                     52:     /* check the size */
                     53:     double dl;
                     54:     res = curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD, &dl);
                     55:     if(!res) {
                     56:       printf("Downloaded %.0f bytes\\n", cl);
                     57:     }
                     58:   }
                     59: }
                     60: .fi
                     61: .SH AVAILABILITY
                     62: Added in 7.4.1
                     63: .SH RETURN VALUE
                     64: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     65: .SH "SEE ALSO"
                     66: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
                     67: .BR CURLINFO_SIZE_DOWNLOAD_T "(3), "
                     68: .BR CURLINFO_SIZE_UPLOAD_T "(3), "