Imported Upstream version 7.53.1
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_PROTOCOL.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_PROTOCOL 3 "23 November 2016" "libcurl 7.52.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_PROTOCOL \- get the protocol used in the connection
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROTOCOL, long *p);
30 .SH DESCRIPTION
31 Pass a pointer to a long to receive the version used in the last http connection.
32 The returned value will be one of the CURLPROTO_* values.
33 .SH PROTOCOLS
34 All
35 .SH EXAMPLE
36 .nf
37 CURL *curl = curl_easy_init();
38 if(curl) {
39   CURLcode res;
40   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
41   res = curl_easy_perform(curl);
42   if(res == CURLE_OK) {
43     long protocol;
44     curl_easy_getinfo(curl, CURLINFO_PROTOCOL, &protocol);
45   }
46   curl_easy_cleanup(curl);
47 }
48 .fi
49 .SH AVAILABILITY
50 Added in 7.52.0
51 .SH RETURN VALUE
52 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
53 .SH "SEE ALSO"
54 .BR CURLINFO_RESPONSE_CODE "(3), "
55 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "