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

Format `args` per `fmtStr` into the output iterator `out`.

== Synopsis

Declared in `<bslfmt_format_imp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_OUT,
    class... t_ARGS>
t_OUT
format_to(
    t_OUT out,
    xref:BloombergLP/bslfmt/wformat_string.adoc[bslfmt::wformat_string<t_ARGS...>] fmtStr,
    t_ARGS const&... args)
requires !bsl::is_same<typename bsl::decay<t_OUT>::type, bsl::wstring *>::value;
----

== Description

Format the specified `args` according to the specification given by the specified `fmtStr`, and write the result of this operation into the output iterator given 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 output parameter.

== Return Value

output iterator after writing

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| output iterator receiving formatted characters
| *fmtStr*
| wide format string
| *args*
| values to format
|===


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