[#BloombergLP-bslfmt-format_to-0bf]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::format_to
:relfileprefix: ../../
:mrdocs:

Format `args` per `fmtStr` into the string addressed by `out`.

== Synopsis

Declared in `<bslfmt_format_imp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class... t_ARGS>
void
format_to(
    xref:bsl/string.adoc[bsl::string]* out,
    xref:BloombergLP/bslfmt/format_string.adoc[bslfmt::format_string<t_ARGS...>] fmtStr,
    t_ARGS const&... args);
----

== Description

Format the specified `args` according to the specification given by the specified `fmtStr`, and write the result of this operation into the string addressed by the specified `out` parameter. In the event of an error the exception `format_error` is thrown. Behavior is undefined if `out` does not point to a valid `bsl::string` object.

== 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]#