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