Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_DISALLOW_USERNAME_IN_URL.3

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