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

`format` overloads

== Synopses

Declared in `<tinyformat.h>`

Format a bilingual string from a bilingual format string and its arguments.


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

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

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


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

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

Format list of arguments to the stream according to given format string.


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

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

== Return Value

* A bilingual_str with the original and translated text formatted independently.
* The formatted result as a string.

== Parameters

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


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