[#tinyformat-format-02]
= xref:tinyformat.adoc[tinyformat]::format
:relfileprefix: ../
:mrdocs:

Format list of arguments according to the given format string and return the result as a string.

== Synopsis

Declared in `<tinyformat.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename... Args>
std::string
format(
    xref:tinyformat/FormatStringCheck.adoc[FormatStringCheck<sizeof...(Args)>] fmt,
    Args const&... args);
----

== Return Value

The formatted result as a string.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *fmt*
| Format string, checked against the number of arguments.
| *args*
| Values to format.
|===


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