blob: ed0224aa3f4f34f7c1b3e4efcc98e0e9eccfb3b0 [file] [log] [blame]
Alex Deymo8f1a2142016-06-28 14:49:26 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Alex Deymo8f1a2142016-06-28 14:49:26 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
12.\" * are also available at https://curl.haxx.se/docs/copyright.html.
13.\" *
14.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15.\" * copies of the Software, and permit persons to whom the Software is
16.\" * furnished to do so, under the terms of the COPYING file.
17.\" *
18.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19.\" * KIND, either express or implied.
20.\" *
21.\" **************************************************************************
22.\"
Elliott Hughes1ef06ba2018-05-30 15:43:58 -070023.TH CURLINFO_TOTAL_TIME 3 "May 05, 2017" "libcurl 7.60.0" "curl_easy_getinfo options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Alex Deymo8f1a2142016-06-28 14:49:26 -070025.SH NAME
26CURLINFO_TOTAL_TIME \- get total time of previous transfer
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_TOTAL_TIME, double *timep);
31.SH DESCRIPTION
32Pass a pointer to a double to receive the total time in seconds for the
33previous transfer, including name resolving, TCP connect etc. The double
34represents the time in seconds, including fractions.
35
36See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
37.SH PROTOCOLS
38All
39.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070040.nf
41curl = curl_easy_init();
42if(curl) {
43 double total;
44 curl_easy_setopt(curl, CURLOPT_URL, url);
45 res = curl_easy_perform(curl);
46 if(CURLE_OK == res) {
47 res = curl_easy_getinfo(curl, CURLINFO_TOTAL_TIME, &total);
48 if(CURLE_OK == res) {
49 printf("Time: %.1f", total);
50 }
51 }
52 /* always cleanup */
53 curl_easy_cleanup(curl);
54}
55.fi
Alex Deymo8f1a2142016-06-28 14:49:26 -070056.SH AVAILABILITY
57Added in 7.4.1
58.SH RETURN VALUE
59Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
60.SH "SEE ALSO"
61.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "