AP05/curl_arm64/share/man/man3/CURLINFO_PROXYAUTH_USED.3
2025-12-02 13:06:35 +08:00

65 lines
1.9 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLINFO_PROXYAUTH_USED.md
.TH CURLINFO_PROXYAUTH_USED 3 "2025-07-07" libcurl
.SH NAME
CURLINFO_PROXYAUTH_USED \- get used HTTP proxy authentication method
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROXYAUTH_USED, long *authp);
.fi
.SH DESCRIPTION
Pass a pointer to a long to receive a bitmask indicating the authentication
method that was used in the previous request done over an HTTP proxy. The
meaning of the possible bits is explained in the \fICURLOPT_HTTPAUTH(3)\fP option
for \fIcurl_easy_setopt(3)\fP.
The returned value has zero or one bit set.
.SH PROTOCOLS
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy.example.com");
curl_easy_setopt(curl, CURLOPT_PROXYAUTH,
CURLAUTH_BASIC | CURLAUTH_DIGEST);
curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "shrek");
curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "swamp");
res = curl_easy_perform(curl);
if(!res) {
long auth;
res = curl_easy_getinfo(curl, CURLINFO_PROXYAUTH_USED, &auth);
if(!res) {
if(!auth)
printf("No auth used\\n");
else {
if(auth == CURLAUTH_DIGEST)
printf("Used Digest proxy authentication\\n");
else
printf("Used Basic proxy authentication\\n");
}
}
}
curl_easy_cleanup(curl);
}
}
.fi
.SH AVAILABILITY
Added in curl 8.12.0
.SH RETURN VALUE
\fIcurl_easy_getinfo(3)\fP returns a CURLcode indicating success or error.
CURLE_OK (0) means everything was OK, non\-zero means an error occurred, see
\fIlibcurl\-errors(3)\fP.
.SH SEE ALSO
.BR CURLINFO_HTTPAUTH_USED (3),
.BR CURLINFO_PROXYAUTH_AVAIL (3),
.BR CURLOPT_HTTPAUTH (3)