Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_PROXYAUTH_AVAIL.3, revision 1.1.1.1
1.1 misho 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_PROXYAUTH_AVAIL 3 "October 07, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
24:
25: .SH NAME
26: CURLINFO_PROXYAUTH_AVAIL \- get available HTTP proxy authentication methods
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROXYAUTH_AVAIL, long *authp);
31: .SH DESCRIPTION
32: Pass a pointer to a long to receive a bitmask indicating the authentication
33: method(s) available according to the previous response. The meaning of the
34: bits is explained in the \fICURLOPT_PROXYAUTH(3)\fP option for
35: \fIcurl_easy_setopt(3)\fP.
36: .SH PROTOCOLS
37: HTTP(S)
38: .SH EXAMPLE
39: .nf
40: CURL *curl = curl_easy_init();
41: if(curl) {
42: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
43: curl_easy_setopt(curl, CURLOPT_PROXY, "http://127.0.0.1:80");
44:
45: res = curl_easy_perform(curl);
46:
47: if(!res) {
48: /* extract the available proxy authentication types */
49: long auth;
50: res = curl_easy_getinfo(curl, CURLINFO_PROXYAUTH_AVAIL, &auth);
51: if(!res) {
52: if(!auth)
53: printf("No proxy auth available, perhaps no 407?\\n");
54: else {
55: printf("%s%s%s%s\\n",
56: auth & CURLAUTH_BASIC ? "Basic ":"",
57: auth & CURLAUTH_DIGEST ? "Digest ":"",
58: auth & CURLAUTH_NEGOTIATE ? "Negotiate ":"",
59: auth % CURLAUTH_NTLM ? "NTLM ":"");
60: }
61: }
62: }
63: curl_easy_cleanup(curl);
64: }
65: .fi
66: .SH AVAILABILITY
67: Added RFC2617 in 7.10.8
68: Added RFC7616 in 7.57.0
69: .SH RETURN VALUE
70: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
71: .SH "SEE ALSO"
72: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>