romenskiy2012/curl

mirror of https://github.com/curl/curl.git synced 2026-05-02 06:47:51 +03:00

Daniel Stenberg 8442c24c9a

CURLINFO: remove 'get' and 'get the' from each short desc

The short descriptions describe the data each info retrieves. The info
itself does not 'get' the data.

This simplifies and shortens the descriptions and make them more
consistent.

Closes #19406

2025-11-08 17:05:55 +01:00

1.3 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

CURLINFO_SPEED_DOWNLOAD_T

libcurl

CURLINFO_SIZE_UPLOAD_T (3)

CURLINFO_SPEED_UPLOAD_T (3)

curl_easy_getinfo (3)

curl_easy_setopt (3)

All

7.55.0

NAME

CURLINFO_SPEED_DOWNLOAD_T - download speed

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T,
                           curl_off_t *speed);

DESCRIPTION

Pass a pointer to a curl_off_t to receive the average download speed that curl measured for the complete download. Measured in bytes/second.

%PROTOCOLS%

EXAMPLE

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);
      }
    }
  }
}

%AVAILABILITY%

RETURN VALUE

curl_easy_getinfo(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1.3 KiB Raw Blame History