:relfileprefix: ../../../
[#boost-urls-url_base-set_encoded_host_name]

= xref:boost.adoc[pass:[boost]]::xref:boost/urls.adoc[pass:[urls]]::xref:boost/urls/url_base.adoc[pass:[url_base]]::set_encoded_host_name


Set the host to a name


== Synopsis

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

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

== Description


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

=== 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.
Calls to allocate may throw.
Exceptions thrown on invalid input.

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

=== Specification

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



== Exceptions

|===
| Name | Thrown on

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

|===



== Parameters

|===
| Name | Description 

| *s*
| 
The string to set.

|===




== See Also


xref:boost/urls/url_base/set_encoded_host.adoc[set_encoded_host]
,
xref:boost/urls/url_base/set_encoded_host_address.adoc[set_encoded_host_address]
,
xref:boost/urls/url_base/set_host.adoc[set_host]
,
xref:boost/urls/url_base/set_host_address.adoc[set_host_address]
,
xref:boost/urls/url_base/set_host_ipv4.adoc[set_host_ipv4]
,
xref:boost/urls/url_base/set_host_ipv6.adoc[set_host_ipv6]
,
xref:boost/urls/url_base/set_host_ipvfuture.adoc[set_host_ipvfuture]
,
xref:boost/urls/url_base/set_host_name.adoc[set_host_name]
.