[#bsl-format_to-0c]
= xref:bsl.adoc[bsl]::format_to
:relfileprefix: ../
:mrdocs:

`format_to` overloads

== Synopses

Declared in `<bslfmt_format.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 throw the exception `format_error`. The behavior is undefined if `out` does not point to a valid `bsl::string` object. Note that this overload is provided in addition to the overloads in the standard library, and the `requires` clause is necessary to avoid ambiguity.


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

[.small]#xref:bsl/format_to-080.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 throw the exception `format_error`. The behavior is undefined if `out` does not point to a valid `bsl::string` object. Note that this overload is provided in addition to the overloads in the standard library, and the requires clause is necessary to avoid ambiguity.


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

[.small]#xref:bsl/format_to-01.adoc[_» more..._]#

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc`, and write the result of this operation into the string addressed by the specified `out` parameter. In the event of an error thrwe the exception `format_error`. The behavior is undefined if `out` does not point to a valid `bsl::string` object. Note that this overload is provided in addition to the overloads in the standard library, and the requires clause is necessary to avoid ambiguity.


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

[.small]#xref:bsl/format_to-086.adoc[_» more..._]#

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc`, and write the result of this operation into the string addressed by the specified `out` parameter. In the event of an error throw the exception `format_error`. The behavior is undefined if `out` does not point to a valid `bsl::string` object. Note that this overload is provided in addition to the overloads in the standard library, and the requires clause is necessary to avoid ambiguity.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_STRING,
    class... t_ARGS>
requires (bsl::is_same_v<t_STRING, bsl::wstring>)
void
xref:bsl/format_to-04.adoc[format_to](
    t_STRING* out,
    std::locale const& loc,
    wformat_string<t_ARGS...> fmtStr,
    t_ARGS&&... args);
----

[.small]#xref:bsl/format_to-04.adoc[_» more..._]#


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