mirror of https://github.com/curl/curl.git synced 2026-04-11 12:01:42 +08:00

Daniel Stenberg b4dba346cd

Everywhere. In documentation and code comments.

It is almost never a good word and almost always a filler that should be
avoided.

Closes #20793

2026-03-03 15:30:22 +01:00

1.9 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

CURLINFO_PRETRANSFER_TIME_T

libcurl

CURLINFO_CONNECT_TIME (3)

CURLINFO_PRETRANSFER_TIME_T (3)

curl_easy_getinfo (3)

curl_easy_setopt (3)

All

7.61.0

NAME

CURLINFO_PRETRANSFER_TIME_T - time to transfer start

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME_T,
                           curl_off_t *timep);

DESCRIPTION

Pass a pointer to a curl_off_t to receive the time, in microseconds, it took from the start until the file transfer is about to begin.

This time-stamp includes all pre-transfer commands and negotiations that are specific to the particular protocol(s) involved. It includes the sending of the protocol-specific instructions that trigger a transfer.

When a redirect is followed, the time from each request is added together.

See also the TIMES overview in the curl_easy_getinfo(3) man page.

%PROTOCOLS%

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_off_t pretransfer;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    result = curl_easy_perform(curl);
    if(result == CURLE_OK) {
      result = curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME_T,
                                 &pretransfer);
      if(result == CURLE_OK) {
        printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld\n",
               pretransfer / 1000000,
               (long)(pretransfer % 1000000));
      }
    }
    /* always cleanup */
    curl_easy_cleanup(curl);
  }
}

%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.9 KiB Raw Blame History