[#boost-urls-format-06]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::format
:relfileprefix: ../../
:mrdocs:

Format arguments into a URL

== Synopses

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

Format arguments into a URL


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:boost/urls/url.adoc[url]
xref:boost/urls/format-02.adoc[format](
    core::string_view fmt,
    std::initializer_list<xref:boost/urls/format_arg.adoc[format_arg]> args);
----

[.small]#xref:boost/urls/format-02.adoc[_» more..._]#

Format arguments into a URL


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<std::convertible_to<xref:boost/urls/format_arg.adoc[format_arg]>... Args>
xref:boost/urls/url.adoc[url]
xref:boost/urls/format-05.adoc[format](
    core::string_view fmt,
    Args&&... args);
----

[.small]#xref:boost/urls/format-05.adoc[_» more..._]#

== Exceptions

[cols=2]
|===
| Name
| Thrown on
| `system_error`
| `fmt` contains an invalid format string and the result contains an invalid URL after replacements are applied.
|===

== Return Value

A URL holding the formatted result.

== Parameters

[cols=2]
|===
| Name
| Description
| *fmt*
| The format URL string.
| *args*
| Arguments to be formatted.
|===

== See Also

xref:boost/urls/format_to-01.adoc[`format_to`].

xref:boost/urls/format_to-01.adoc[`format_to`], xref:boost/urls/arg.adoc[`arg`].


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