| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 |
- .\" generated by cd2nroff 0.1 from CURLINFO_SPEED_DOWNLOAD_T.md
- .TH CURLINFO_SPEED_DOWNLOAD_T 3 "2025-01-17" libcurl
- .SH NAME
- CURLINFO_SPEED_DOWNLOAD_T \- get download speed
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T,
- curl_off_t *speed);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a \fIcurl_off_t\fP to receive the average download speed
- that curl measured for the complete download. Measured in bytes/second.
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .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) {
- curl_off_t speed;
- res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD_T, &speed);
- if(!res) {
- printf("Download speed %" CURL_FORMAT_CURL_OFF_T " bytes/sec\\n",
- speed);
- }
- }
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 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_UPLOAD_T (3),
- .BR CURLINFO_SPEED_UPLOAD_T (3),
- .BR curl_easy_getinfo (3),
- .BR curl_easy_setopt (3)
|