[#boost-urls-url-set_host_name]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/url.adoc[url]::set&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/url.hpp#L460[boost&sol;url&sol;url&period;hpp]&gt;`

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

== Description

The host is set to the specified string, which may be empty&period; 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_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;

== BNF

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

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

== Return Value

`&ast;this`

== Parameters

[cols="1,4"]
|===
| 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_encoded_host_name.adoc[`set&lowbar;encoded&lowbar;host&lowbar;name`], 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`]&period;


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