2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-08-19 12:46:58 +00:00
repo/core/curl/files/CURLOPT_DISALLOW_USERNAME_IN_URL.3
2024-06-01 15:49:19 -05:00

48 lines
1.2 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_DISALLOW_USERNAME_IN_URL.md
.TH CURLOPT_DISALLOW_USERNAME_IN_URL 3 "2024-06-01" libcurl
.SH NAME
CURLOPT_DISALLOW_USERNAME_IN_URL \- disallow specifying username in the URL
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DISALLOW_USERNAME_IN_URL,
long disallow);
.fi
.SH DESCRIPTION
A long parameter set to 1 tells the library to not allow URLs that include a
username.
This is the equivalent to the \fICURLU_DISALLOW_USER\fP flag for the
\fIcurl_url_set(3)\fP function.
.SH DEFAULT
0 (disabled) \- usernames are allowed by default.
.SH PROTOCOLS
All
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
curl_easy_setopt(curl, CURLOPT_DISALLOW_USERNAME_IN_URL, 1L);
curl_easy_perform(curl);
}
}
.fi
.SH AVAILABILITY
Added in 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
\fIcurl_easy_perform(3)\fP returns CURLE_LOGIN_DENIED if this option is
enabled and a URL containing a username is specified.
.SH SEE ALSO
.BR CURLOPT_PROTOCOLS (3),
.BR CURLOPT_URL (3),
.BR curl_url_set (3),
.BR libcurl-security (3)