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