CURLINFO_SIZE_DOWNLOAD_T.md (1573B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Title: CURLINFO_SIZE_DOWNLOAD_T 5 Section: 3 6 Source: libcurl 7 See-also: 8 - CURLINFO_SIZE_DOWNLOAD (3) 9 - CURLINFO_SIZE_UPLOAD_T (3) 10 - CURLOPT_MAXFILESIZE (3) 11 - curl_easy_getinfo (3) 12 - curl_easy_setopt (3) 13 Protocol: 14 - All 15 Added-in: 7.55.0 16 --- 17 18 # NAME 19 20 CURLINFO_SIZE_DOWNLOAD_T - get the number of downloaded bytes 21 22 # SYNOPSIS 23 24 ~~~c 25 #include <curl/curl.h> 26 27 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_DOWNLOAD_T, 28 curl_off_t *dlp); 29 ~~~ 30 31 # DESCRIPTION 32 33 Pass a pointer to a *curl_off_t* to receive the total amount of bytes that 34 were downloaded. The amount is only for the latest transfer and gets reset 35 again for each new transfer. This counts actual payload data, what's also 36 commonly called body. All meta and header data is excluded from this amount. 37 38 # %PROTOCOLS% 39 40 # EXAMPLE 41 42 ~~~c 43 int main(void) 44 { 45 CURL *curl = curl_easy_init(); 46 if(curl) { 47 CURLcode res; 48 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); 49 50 /* Perform the request */ 51 res = curl_easy_perform(curl); 52 53 if(!res) { 54 /* check the size */ 55 curl_off_t dl; 56 res = curl_easy_getinfo(curl, CURLINFO_SIZE_DOWNLOAD_T, &dl); 57 if(!res) { 58 printf("Downloaded %" CURL_FORMAT_CURL_OFF_T " bytes\n", dl); 59 } 60 } 61 } 62 } 63 ~~~ 64 65 # %AVAILABILITY% 66 67 # RETURN VALUE 68 69 curl_easy_setopt(3) returns a CURLcode indicating success or error. 70 71 CURLE_OK (0) means everything was OK, non-zero means an error occurred, see 72 libcurl-errors(3).