mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
52 lines
1.4 KiB
Groff
52 lines
1.4 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLINFO_SIZE_DOWNLOAD_T.md
|
|
.TH CURLINFO_SIZE_DOWNLOAD_T 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLINFO_SIZE_DOWNLOAD_T \- get the number of downloaded bytes
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_DOWNLOAD_T,
|
|
curl_off_t *dlp);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a \fIcurl_off_t\fP to receive the total amount of bytes that
|
|
were downloaded. The amount is only for the latest transfer and gets reset
|
|
again for each new transfer. This counts actual payload data, what\(aqs also
|
|
commonly called body. All meta and header data is excluded from this amount.
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://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);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.55.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLINFO_SIZE_DOWNLOAD (3),
|
|
.BR CURLINFO_SIZE_UPLOAD_T (3),
|
|
.BR CURLOPT_MAXFILESIZE (3),
|
|
.BR curl_easy_getinfo (3),
|
|
.BR curl_easy_setopt (3)
|