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

`format` overloads

== Synopses

Declared in `<bslfmt_format_imp.h>`

Format `args` according to `fmtStr` and return a `bsl::string`.


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

[.small]#xref:BloombergLP/bslfmt/format-01.adoc[_» more..._]#

Format `args` according to `fmtStr` and return a `bsl::wstring`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class... t_ARGS>
xref:bsl/wstring.adoc[bsl::wstring]
xref:BloombergLP/bslfmt/format-096.adoc[format](
    xref:BloombergLP/bslfmt/wformat_string.adoc[bslfmt::wformat_string<t_ARGS...>] fmtStr,
    t_ARGS const&... args);
----

[.small]#xref:BloombergLP/bslfmt/format-096.adoc[_» more..._]#

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


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class... t_ARGS>
xref:bsl/string.adoc[bsl::string]
xref:BloombergLP/bslfmt/format-06.adoc[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]#xref:BloombergLP/bslfmt/format-06.adoc[_» more..._]#

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


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

[.small]#xref:BloombergLP/bslfmt/format-099.adoc[_» more..._]#

== Return Value

* the formatted string
* the formatted wide string

== Parameters

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


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