1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_REDIRECT_TIME_T
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_REDIRECT_COUNT (3)
9  - CURLINFO_REDIRECT_TIME (3)
10  - CURLINFO_REDIRECT_URL (3)
11  - curl_easy_getinfo (3)
12  - curl_easy_setopt (3)
13Protocol:
14  - HTTP
15---
16
17# NAME
18
19CURLINFO_REDIRECT_TIME_T - get the time for all redirection steps
20
21# SYNOPSIS
22
23~~~c
24#include <curl/curl.h>
25
26CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_TIME_T,
27                           curl_off_t *timep);
28~~~
29
30# DESCRIPTION
31
32Pass a pointer to a curl_off_t to receive the total time, in microseconds, it
33took for all redirection steps include name lookup, connect, pretransfer and
34transfer before final transaction was started.
35CURLINFO_REDIRECT_TIME_T(3) holds the complete execution time for
36multiple redirections.
37
38See also the TIMES overview in the curl_easy_getinfo(3) man page.
39
40# EXAMPLE
41
42~~~c
43int main(void)
44{
45  CURL *curl = curl_easy_init();
46  if(curl) {
47    CURLcode res;
48    curl_off_t redirect;
49    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
50    res = curl_easy_perform(curl);
51    if(CURLE_OK == res) {
52      res = curl_easy_getinfo(curl, CURLINFO_REDIRECT_TIME_T, &redirect);
53      if(CURLE_OK == res) {
54        printf("Time: %" CURL_FORMAT_CURL_OFF_T ".%06ld", redirect / 1000000,
55               (long)(redirect % 1000000));
56      }
57    }
58    /* always cleanup */
59    curl_easy_cleanup(curl);
60  }
61}
62~~~
63
64# AVAILABILITY
65
66Added in 7.61.0
67
68# RETURN VALUE
69
70Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
71