[#bsl-format-0a]
= xref:bsl.adoc[bsl]::format
:relfileprefix: ../
:mrdocs:

Format `args` according to `fmtStr` using locale `loc`.

== Synopsis

Declared in `<bslfmt_format.h>`

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

== Description

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc` and return the result. In the event of an error throw the exception `format_error`.

== Return Value

the formatted wide string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *loc*
| locale used for locale‐dependent formatting
| *fmtStr*
| wide format string
| *args*
| values to format
|===


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