[#boost-urls-static_url-set_encoded_host_name-0b]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/static_url.adoc[static&lowbar;url]::set&lowbar;encoded&lowbar;host&lowbar;name
:relfileprefix: ../../../
:mrdocs:


Set the host to a name

== Synopsis


Declared in `&lt;https://www.github.com/boostorg/url/blob/develop/include/boost/url/static_url.hpp#L390[boost&sol;url&sol;static&lowbar;url&period;hpp]&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:boost/urls/static_url.adoc[static&lowbar;url]&
set&lowbar;encoded&lowbar;host&lowbar;name(xref:boost/urls/pct_string_view.adoc[pct&lowbar;string&lowbar;view] s);
----

== Description


The host is set to the specified string,        which may contain percent&hyphen;escapes and        can be empty&period;        Escapes in the string are preserved,        and reserved characters in the string        are percent&hyphen;escaped in the result&period;        The host type is xref:boost/urls/host_type.adoc[host&lowbar;type&colon;&colon;name]&period;


=== Example

[,cpp]
----
assert( url( "http://www.example.com/index.htm").set_encoded_host_name( "localhost" ).host_address() == "localhost" );
----

=== Postconditions

[,cpp]
----
this->has_authority() == true && this->host_ipv6_address() == addr && this->host_type() == host_type::name
----

=== Exception Safety

Strong guarantee&period;        Calls to allocate may throw&period;        Exceptions thrown on invalid input&period;


=== BNF

[,cpp]
----
reg-name    = *( unreserved / pct-encoded / "-" / ".")
----

=== Specification

* link:https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2[            3&period;2&period;2&period; Host (rfc3986)]



== Exceptions


|===
| Name | Thrown on

| `system&lowbar;error`
| `s` contains an invalid percent&hyphen;encoding&period;


|===

== Parameters


|===
| Name | Description

| *s*
| The string to set&period;


|===

== See Also


xref:boost/urls/url_base/set_encoded_host.adoc[set&lowbar;encoded&lowbar;host],            xref:boost/urls/url_base/set_encoded_host_address.adoc[set&lowbar;encoded&lowbar;host&lowbar;address],            xref:boost/urls/url_base/set_host.adoc[set&lowbar;host],            xref:boost/urls/url_base/set_host_address.adoc[set&lowbar;host&lowbar;address],            xref:boost/urls/url_base/set_host_ipv4.adoc[set&lowbar;host&lowbar;ipv4],            xref:boost/urls/url_base/set_host_ipv6.adoc[set&lowbar;host&lowbar;ipv6],            xref:boost/urls/url_base/set_host_ipvfuture.adoc[set&lowbar;host&lowbar;ipvfuture],            xref:boost/urls/url_base/set_host_name.adoc[set&lowbar;host&lowbar;name]&period;






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