[#boost-urls-url_view_base-password]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/url_view_base.adoc[url&lowbar;view&lowbar;base]::password
:relfileprefix: ../../../
:mrdocs:


Return the password

== Synopsis


Declared in `&lt;https://www.github.com/boostorg/url/blob/develop/include/boost/url/url_view_base.hpp#L889[boost&sol;url&sol;url&lowbar;view&lowbar;base&period;hpp]&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;xref:boost/urls/string_token.adoc[string&lowbar;token]::xref:boost/urls/string_token/StringToken.adoc[StringToken] StringToken = xref:boost/urls/string_token.adoc[string&lowbar;token]::xref:boost/urls/string_token/return_string.adoc[return&lowbar;string]&gt;
StringToken::result&lowbar;type
password(StringToken&& token = &lcub;&rcub;);
----

== Description


If present, this function returns a        string representing the password (which        may be an empty string)&period;        Otherwise it returns an empty string&period;        Any percent&hyphen;escapes in the string are        decoded first&period;


=== Example

[,cpp]
----
assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" );
----

=== Complexity

Linear in `this&hyphen;&gt;password()&period;size()`&period;


=== Exception Safety

Calls to allocate may throw&period;


=== 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&period;2&period;1&period; User Information (rfc3986)]

Return the password

If present, this function returns a        string representing the password (which        may be an empty string)&period;        Otherwise it returns an empty string&period;        Any percent&hyphen;escapes in the string are        decoded first&period;


=== Example

[,cpp]
----
assert( url_view( "http://jane%2Ddoe:pass@example.com" ).password() == "pass" );
----

=== Complexity

Linear in `this&hyphen;&gt;password()&period;size()`&period;


=== Exception Safety

Calls to allocate may throw&period;


=== 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&period;2&period;1&period; User Information (rfc3986)]



== See Also


xref:boost/urls/url_view_base/has_password.adoc[has&lowbar;password],            xref:boost/urls/url_view_base/has_userinfo.adoc[has&lowbar;userinfo],            xref:boost/urls/url_view_base/encoded_password.adoc[encoded&lowbar;password],            xref:boost/urls/url_view_base/encoded_user.adoc[encoded&lowbar;user],            xref:boost/urls/url_view_base/encoded_userinfo.adoc[encoded&lowbar;userinfo],            xref:boost/urls/url_view_base/user.adoc[user],            xref:boost/urls/url_view_base/userinfo.adoc[userinfo]&period;



xref:boost/urls/url_view_base/has_password.adoc[has&lowbar;password],            xref:boost/urls/url_view_base/has_userinfo.adoc[has&lowbar;userinfo],            xref:boost/urls/url_view_base/encoded_password.adoc[encoded&lowbar;password],            xref:boost/urls/url_view_base/encoded_user.adoc[encoded&lowbar;user],            xref:boost/urls/url_view_base/encoded_userinfo.adoc[encoded&lowbar;userinfo],            xref:boost/urls/url_view_base/user.adoc[user],            xref:boost/urls/url_view_base/userinfo.adoc[userinfo]&period;






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