[#BloombergLP-bslfmt-format-096]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::format
:relfileprefix: ../../
:mrdocs:

Format `args` according to `fmtStr` and return a `bsl&colon;&colon;wstring`&period;

== Synopsis

Declared in `&lt;bslfmt&lowbar;format&lowbar;imp&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class&period;&period;&period; t&lowbar;ARGS&gt;
xref:bsl/wstring.adoc[bsl::wstring]
format(
    xref:BloombergLP/bslfmt/wformat_string.adoc[bslfmt::wformat&lowbar;string&lt;t&lowbar;ARGS&period;&period;&period;&gt;] fmtStr,
    t&lowbar;ARGS const&&period;&period;&period; args);
----

== Description

Format the specified `args` according to the specification given by the specified `fmtStr` and return the result as a `bsl&colon;&colon;wstring`&period; In the event of an error the exception `format&lowbar;error` is thrown&period;

== Return Value

the formatted wide string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *fmtStr*
| wide format string
| *args*
| values to format
|===


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