1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_PRETRANSFER_TIME_T
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_CONNECT_TIME (3)
9  - CURLINFO_PRETRANSFER_TIME_T (3)
10  - curl_easy_getinfo (3)
11  - curl_easy_setopt (3)
12Protocol:
13  - All
14---
15
16# NAME
17
18CURLINFO_PRETRANSFER_TIME_T - get the time until the file transfer start
19
20# SYNOPSIS
21
22~~~c
23#include <curl/curl.h>
24
25CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME_T,
26                           curl_off_t *timep);
27~~~
28
29# DESCRIPTION
30
31Pass a pointer to a curl_off_t to receive the time, in microseconds, it took
32from the start until the file transfer is just about to begin.
33
34This time-stamp includes all pre-transfer commands and negotiations that are
35specific to the particular protocol(s) involved. It includes the sending of
36the protocol-specific instructions that trigger a transfer.
37
38When a redirect is followed, the time from each request is added together.
39
40See also the TIMES overview in the curl_easy_getinfo(3) man page.
41
42# EXAMPLE
43
44~~~c
45int main(void)
46{
47  CURL *curl = curl_easy_init();
48  if(curl) {
49    CURLcode res;
50    curl_off_t pretransfer;
51    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
52    res = curl_easy_perform(curl);
53    if(CURLE_OK == res) {
54      res = curl_easy_getinfo(curl, CURLINFO_PRETRANSFER_TIME_T, &pretransfer);
55      if(CURLE_OK == res) {
56        printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld\n",
57               pretransfer / 1000000,
58               (long)(pretransfer % 1000000));
59      }
60    }
61    /* always cleanup */
62    curl_easy_cleanup(curl);
63  }
64}
65~~~
66
67# AVAILABILITY
68
69Added in 7.61.0
70
71# RETURN VALUE
72
73Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
74