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

Format list of arguments to the stream according to given format string&period;

== Synopsis

Declared in `&lt;tinyformat&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;typename&period;&period;&period; Args&gt;
void
format(
    std::ostream& out,
    xref:tinyformat/FormatStringCheck.adoc[FormatStringCheck&lt;sizeof&period;&period;&period;(Args)&gt;] fmt,
    Args const&&period;&period;&period; args);
----

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| Stream to write the formatted output to&period;
| *fmt*
| Format string, checked against the number of arguments&period;
| *args*
| Values to format&period;
|===


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