[#boost-urls-url-set_encoded_password]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/url.adoc[url]::set_encoded_password
:relfileprefix: ../../../
:mrdocs:


Set the password.

== Synopsis


Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/url.hpp#L434[boost/url/url.hpp]>`

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

== Description


This function sets the password in        the userinfo to the string, which        may contain percent‐escapes.        Escapes in the string are preserved,        and 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_encoded_password( "pass" ).encoded_userinfo() == "user:pass" );
----

=== Postconditions

[,cpp]
----
this->has_password() == true
----

=== 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)]



== Exceptions


|===
| Name | Thrown on

| `system_error`
| `s` contains an invalid percent‐encoding.


|===

== 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].






[.small]#Created with https://www.mrdocs.com[MrDocs]#