[#bsl-vformat-0ef]
= xref:bsl.adoc[bsl]::vformat
:relfileprefix: ../
:mrdocs:

Format `args` according to `fmtStr` using allocator and locale.

== Synopsis

Declared in `<bslfmt_format.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/wstring.adoc[bsl::wstring]
vformat(
    xref:bsl/allocator-0df.adoc[allocator<wchar_t>] alloc,
    std::locale const& loc,
    std::wstring_view fmtStr,
    std::wformat_args args);
----

== Description

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc`, using the specified `allocator` to supply memory (if required), 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
| *alloc*
| allocator used to supply memory
| *loc*
| locale used for locale‐dependent formatting
| *fmtStr*
| wide format string
| *args*
| type‐erased format arguments
|===


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