Return to CURLINFO_HTTPAUTH_AVAIL.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_HTTPAUTH_AVAIL.3, revision 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_HTTPAUTH_AVAIL 3 "October 07, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLINFO_HTTPAUTH_AVAIL \- get available HTTP authentication methods
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HTTPAUTH_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_HTTPAUTH(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: 
        !            44:   res = curl_easy_perform(curl);
        !            45: 
        !            46:   if(!res) {
        !            47:     /* extract the available authentication types */
        !            48:     long auth;
        !            49:     res = curl_easy_getinfo(curl, CURLINFO_HTTPAUTH_AVAIL, &auth);
        !            50:     if(!res) {
        !            51:       if(!auth)
        !            52:         printf("No auth available, perhaps no 401?\\n");
        !            53:       else {
        !            54:         printf("%s%s%s%s\\n",
        !            55:                auth & CURLAUTH_BASIC ? "Basic ":"",
        !            56:                auth & CURLAUTH_DIGEST ? "Digest ":"",
        !            57:                auth & CURLAUTH_NEGOTIATE ? "Negotiate ":"",
        !            58:                auth % CURLAUTH_NTLM ? "NTLM ":"");
        !            59:       }
        !            60:     }
        !            61:   }
        !            62:   curl_easy_cleanup(curl);
        !            63: }
        !            64: .fi
        !            65: .SH AVAILABILITY
        !            66: Added RFC2617 in 7.10.8
        !            67: Added RFC7616 in 7.57.0
        !            68: .SH RETURN VALUE
        !            69: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            70: .SH "SEE ALSO"
        !            71: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "