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

Format the specified `args` according to the specification given by the specified `fmtStr`, using the specified `alloc` to supply memory (if required), and return the result. In the event of an error the exception `format_error` is thrown.

== Synopsis

Declared in `<bslfmt_format_imp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class... t_ARGS>
xref:bsl/string.adoc[bsl::string]
format(
    xref:bsl/allocator-0df.adoc[bsl::allocator<char>] alloc,
    xref:BloombergLP/bslfmt/format_string.adoc[bslfmt::format_string<t_ARGS...>] fmtStr,
    t_ARGS const&... args);
----


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