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

`format_to` overloads

== Synopses

Declared in `<bslfmt_format_imp.h>`

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.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class... t_ARGS>
void
xref:BloombergLP/bslfmt/format_to-0bf.adoc[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);
----

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

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.


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

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

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.


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

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

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.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_OUT,
    class... t_ARGS>
t_OUT
xref:BloombergLP/bslfmt/format_to-0d.adoc[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;
----

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


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