Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_TOTAL_TIME.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
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 .\"
23 .TH CURLINFO_TOTAL_TIME 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
24
25 .SH NAME
26 CURLINFO_TOTAL_TIME \- get total time of previous transfer
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_TOTAL_TIME, double *timep);
31 .SH DESCRIPTION
32 Pass a pointer to a double to receive the total time in seconds for the
33 previous transfer, including name resolving, TCP connect etc. The double
34 represents the time in seconds, including fractions.
35
36 See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
37 .SH PROTOCOLS
38 All
39 .SH EXAMPLE
40 .nf
41 curl = curl_easy_init();
42 if(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
56 .SH AVAILABILITY
57 Added in 7.4.1
58 .SH RETURN VALUE
59 Returns 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), "