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

`format` overloads

== Synopses

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

Format a bilingual string from a bilingual format string and its arguments&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;typename&period;&period;&period; Args&gt;
xref:bilingual_str.adoc[bilingual&lowbar;str]
xref:tinyformat/format-0a.adoc[format](
    xref:util/BilingualFmt.adoc[util::BilingualFmt&lt;sizeof&period;&period;&period;(Args)&gt;] fmt,
    Args const&&period;&period;&period; args);
----

[.small]#xref:tinyformat/format-0a.adoc[_» more&period;&period;&period;_]#

Format list of arguments according to the given format string and return the result as a string&period;


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

[.small]#xref:tinyformat/format-02.adoc[_» more&period;&period;&period;_]#

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


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

[.small]#xref:tinyformat/format-00.adoc[_» more&period;&period;&period;_]#

== Return Value

* A bilingual&lowbar;str with the original and translated text formatted independently&period;
* The formatted result as a string&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *fmt*
| The bilingual format string&period;
| *args*
| The format arguments, whose original&sol;translated parts are selected per side&period;
| *out*
| Stream to write the formatted output to&period;
|===


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