:relfileprefix: ../../../
[#boost-urls-url-set_password]

= xref:boost.adoc[pass:[boost]]::xref:boost/urls.adoc[pass:[urls]]::xref:boost/urls/url.adoc[pass:[url]]::set_password


Set the password.


== Synopsis

Declared in header `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/url.hpp#L431[boost/url/url.hpp,window=blank_]>`

[source,cpp,subs="verbatim,macros,-callouts"]
----
xref:boost/urls/url.adoc[url]&
set_password(core::string_view s);
----

== Description


This function sets the password in
the userinfo to the string.
Reserved characters in the string are
percent-escaped in the result.
[NOTE]

The interpretation of the userinfo as
individual user and password components
is scheme-dependent. Transmitting
passwords in URLs is deprecated.

=== Example
[,cpp]
----
assert( url("http://user@example.com").set_password( "pass" ).encoded_userinfo() == "user:pass" );
----

=== Postconditions
[,cpp]
----
this->has_password() == true && this->password() == s
----

=== Exception Safety

Strong guarantee.
Calls to allocate may throw.

=== BNF
[,cpp]
----
userinfo      = [ [ user ] [ ':' password ] ]

user          = *( unreserved / pct-encoded / sub-delims )
password      = *( unreserved / pct-encoded / sub-delims / ":" )
----

=== Specification

* link:https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.1[            3.2.1. User Information (rfc3986)]





== Parameters

|===
| Name | Description 

| *s*
| 
The string to set. This string may
contain any characters, including nulls.

|===




== See Also


xref:boost/urls/url_base/remove_password.adoc[remove_password]
,
xref:boost/urls/url_base/set_encoded_password.adoc[set_encoded_password]
,
xref:boost/urls/url_base/set_encoded_user.adoc[set_encoded_user]
,
xref:boost/urls/url_base/set_user.adoc[set_user]
.