[#boost-urls-authority_view-encoded_host_name]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::xref:boost/urls/authority_view.adoc[authority_view]::encoded_host_name
:relfileprefix: ../../../
:mrdocs:


Return the host name

== Synopsis


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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:boost/urls/pct_string_view.adoc[pct_string_view]
encoded_host_name() const noexcept;
----

== Description


If the host type is xref:boost/urls/host_type.adoc[host_type::name],        this function returns the name as        a string.        Otherwise, if the host type is not an        name, it returns an empty string.        The returned string may contain        percent escapes.


=== Example

[,cpp]
----
assert( url_view( "https://www%2droot.example.com/" ).encoded_host_name() == "www%2droot.example.com" );
----

=== Complexity

Constant.


=== Exception Safety

Throws nothing.


=== BNF

[,cpp]
----
host        = IP-literal / IPv4address / reg-name

IP-literal  = "[" ( IPv6address / IPvFuture  ) "]"

reg-name    = *( unreserved / pct-encoded / "-" / ".")
----

=== Specification

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





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