Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_HTTP_VERSION.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2016, 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_HTTP_VERSION 3 "May 11, 2016" "libcurl 7.59.0" "curl_easy_getinfo options"
24
25 .SH NAME
26 CURLINFO_HTTP_VERSION \- get the http version used in the connection
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HTTP_VERSION, long *p);
31 .SH DESCRIPTION
32 Pass a pointer to a long to receive the version used in the last http connection.
33 The returned value will be CURL_HTTP_VERSION_1_0, CURL_HTTP_VERSION_1_1, or
34 CURL_HTTP_VERSION_2_0, or 0 if the version can't be determined.
35 .SH PROTOCOLS
36 HTTP
37 .SH EXAMPLE
38 .nf
39 CURL *curl = curl_easy_init();
40 if(curl) {
41   CURLcode res;
42   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
43   res = curl_easy_perform(curl);
44   if(res == CURLE_OK) {
45     long http_version;
46     curl_easy_getinfo(curl, CURLINFO_HTTP_VERSION, &http_version);
47   }
48   curl_easy_cleanup(curl);
49 }
50 .fi
51 .SH AVAILABILITY
52 Added in 7.50.0
53 .SH RETURN VALUE
54 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
55 .SH "SEE ALSO"
56 .BR CURLINFO_RESPONSE_CODE "(3), "
57 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "