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

`vformat_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.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:bsl/vformat_to-09.adoc[vformat_to](
    xref:bsl/string.adoc[string]* out,
    std::string_view fmtStr,
    std::format_args args);
----

[.small]#xref:bsl/vformat_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 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::wstring` object. Note that this overload is provided in addition to the overloads in the standard library.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:bsl/vformat_to-0d.adoc[vformat_to](
    xref:bsl/wstring.adoc[wstring]* out,
    std::wstring_view fmtStr,
    std::wformat_args args);
----

[.small]#xref:bsl/vformat_to-0d.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.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:bsl/vformat_to-0f.adoc[vformat_to](
    xref:bsl/string.adoc[string]* out,
    std::locale const& loc,
    std::string_view fmtStr,
    std::format_args args);
----

[.small]#xref:bsl/vformat_to-0f.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::wstring` object. Note that this overload is provided in addition to the overloads in the standard library.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:bsl/vformat_to-0a.adoc[vformat_to](
    xref:bsl/wstring.adoc[wstring]* out,
    std::locale const& loc,
    std::wstring_view fmtStr,
    std::wformat_args args);
----

[.small]#xref:bsl/vformat_to-0a.adoc[_» more..._]#


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