[#BloombergLP-bslfmt-vformat-0b]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::vformat
:relfileprefix: ../../
:mrdocs:

Format `args` according to the specification in `fmtStr`.

== Synopsis

Declared in `<bslfmt_format_imp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/wstring.adoc[bsl::wstring]
vformat(
    std::wstring_view fmtStr,
    xref:BloombergLP/bslfmt/wformat_args.adoc[wformat_args] args);
----

== Description

Format the specified `args` according to the specification given by the specified `fmtStr` and return the result. In the event of an error the exception `format_error` is thrown.

== Return Value

the formatted wide string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *fmtStr*
| wide format string
| *args*
| type‐erased wide format arguments
|===


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