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

Format `args` according to `fmtStr` using allocator `alloc`.

== Synopsis

Declared in `<bslfmt_format.h>`

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

== Description

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 throw the exception `format_error`.

== Return Value

the formatted string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *alloc*
| allocator used to supply memory
| *fmtStr*
| format string
| *args*
| values to format
|===


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