Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLINFO_SIZE_DOWNLOAD_T (3)

Name

CURLINFO_SIZE_DOWNLOAD_T - get the number of downloaded bytes

Synopsis

#include <curl/curl.h>

CURLcode   curl_easy_getinfo(CURL   *handle,  CURLINFO_SIZE_DOWNLOAD_T,
curl_off_t *dlp);

Description

curl_easy_getinfo options                          CURLINFO_SIZE_DOWNLOAD_T(3)



NAME
       CURLINFO_SIZE_DOWNLOAD_T - get the number of downloaded bytes

SYNOPSIS
       #include <curl/curl.h>

       CURLcode   curl_easy_getinfo(CURL   *handle,  CURLINFO_SIZE_DOWNLOAD_T,
       curl_off_t *dlp);

DESCRIPTION
       Pass a pointer to a curl_off_t 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.

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");

         /* Perform the request */
         res = curl_easy_perform(curl);

         if(!res) {
           /* check the size */
           curl_off_t dl;
           res = curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD_T, &dl);
           if(!res) {
             printf("Downloaded %" CURL_FORMAT_CURL_OFF_T " bytes\n", dl);
           }
         }
       }

AVAILABILITY
       Added in 7.55.0

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_easy_getinfo(3),  curl_easy_setopt(3),  CURLINFO_SIZE_DOWNLOAD(3),
       CURLINFO_SIZE_UPLOAD_T(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.55.0                    25 May 2017
                                                   CURLINFO_SIZE_DOWNLOAD_T(3)