[#BloombergLP-bslfmt-format_to-0b3]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::format&lowbar;to
:relfileprefix: ../../
:mrdocs:

`format&lowbar;to` overloads

== Synopses

Declared in `&lt;bslfmt&lowbar;format&lowbar;imp&period;h&gt;`

Format `args` per `fmtStr` into the string addressed by `out`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class&period;&period;&period; t&lowbar;ARGS&gt;
void
xref:BloombergLP/bslfmt/format_to-0bf.adoc[format&lowbar;to](
    xref:bsl/string.adoc[bsl::string]* out,
    xref:BloombergLP/bslfmt/format_string.adoc[bslfmt::format&lowbar;string&lt;t&lowbar;ARGS&period;&period;&period;&gt;] fmtStr,
    t&lowbar;ARGS const&&period;&period;&period; args);
----

[.small]#xref:BloombergLP/bslfmt/format_to-0bf.adoc[_» more&period;&period;&period;_]#

Format `args` per `fmtStr` into the string addressed by `out`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class&period;&period;&period; t&lowbar;ARGS&gt;
void
xref:BloombergLP/bslfmt/format_to-09.adoc[format&lowbar;to](
    xref:bsl/wstring.adoc[bsl::wstring]* out,
    xref:BloombergLP/bslfmt/wformat_string.adoc[bslfmt::wformat&lowbar;string&lt;t&lowbar;ARGS&period;&period;&period;&gt;] fmtStr,
    t&lowbar;ARGS const&&period;&period;&period; args);
----

[.small]#xref:BloombergLP/bslfmt/format_to-09.adoc[_» more&period;&period;&period;_]#

Format `args` per `fmtStr` into the output iterator `out`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    class t&lowbar;OUT,
    class&period;&period;&period; t&lowbar;ARGS&gt;
t&lowbar;OUT
xref:BloombergLP/bslfmt/format_to-0e.adoc[format&lowbar;to](
    t&lowbar;OUT out,
    xref:BloombergLP/bslfmt/format_string.adoc[bslfmt::format&lowbar;string&lt;t&lowbar;ARGS&period;&period;&period;&gt;] fmtStr,
    t&lowbar;ARGS const&&period;&period;&period; args)
requires !bsl&colon;&colon;is&lowbar;same&lt;typename bsl&colon;&colon;decay&lt;t&lowbar;OUT&gt;&colon;&colon;type, bsl&colon;&colon;string &ast;&gt;&colon;&colon;value;
----

[.small]#xref:BloombergLP/bslfmt/format_to-0e.adoc[_» more&period;&period;&period;_]#

Format `args` per `fmtStr` into the output iterator `out`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    class t&lowbar;OUT,
    class&period;&period;&period; t&lowbar;ARGS&gt;
t&lowbar;OUT
xref:BloombergLP/bslfmt/format_to-0d.adoc[format&lowbar;to](
    t&lowbar;OUT out,
    xref:BloombergLP/bslfmt/wformat_string.adoc[bslfmt::wformat&lowbar;string&lt;t&lowbar;ARGS&period;&period;&period;&gt;] fmtStr,
    t&lowbar;ARGS const&&period;&period;&period; args)
requires !bsl&colon;&colon;is&lowbar;same&lt;typename bsl&colon;&colon;decay&lt;t&lowbar;OUT&gt;&colon;&colon;type, bsl&colon;&colon;wstring &ast;&gt;&colon;&colon;value;
----

[.small]#xref:BloombergLP/bslfmt/format_to-0d.adoc[_» more&period;&period;&period;_]#

== Return Value

output iterator after writing

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| address of the string receiving formatted characters
| *fmtStr*
| format string
| *args*
| values to format
|===


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