Return to CURLOPT_DISALLOW_USERNAME_IN_URL.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_DISALLOW_USERNAME_IN_URL.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2018, 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 CURLOPT_DISALLOW_USERNAME_IN_URL 3 "February 25, 2018" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_DISALLOW_USERNAME_IN_URL \- disallow specifying username in the url
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DISALLOW_USERNAME_IN_URL, long disallow);
                     31: .SH DESCRIPTION
                     32: A long parameter set to 1 tells the library to not allow URLs that include a
                     33: username.
                     34: .SH DEFAULT
                     35: 0 (disabled) - user names are allowed by default.
                     36: .SH PROTOCOLS
                     37: Several
                     38: .SH EXAMPLE
                     39: .nf
                     40: CURL *curl = curl_easy_init();
                     41: if(curl) {
                     42: 
                     43:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     44:   curl_easy_setopt(curl, CURLOPT_DISALLOW_USERNAME_IN_URL, 1L);
                     45: 
                     46:   curl_easy_perform(curl);
                     47: }
                     48: .fi
                     49: .SH AVAILABILITY
                     50: Added in libcurl 7.61.0
                     51: .SH RETURN VALUE
                     52: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     53: 
                     54: curl_easy_perform() will return CURLE_LOGIN_DENIED if this option is enabled
                     55: and a URL containing a username is specified.
                     56: .SH "SEE ALSO"
                     57: .BR libcurl-security "(3), ", CURLOPT_PROTOCOLS "(3)"