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

`format` overloads

== Synopses

Declared in `<bslfmt_format.h>`

Format the specified `args` according to the specification given by the specified `fmtStr` and return the result as a `bsl::string`. In the event of an error throw the exception `format_error`.


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

[.small]#xref:bsl/format-07.adoc[_» more..._]#

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


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

[.small]#xref:bsl/format-05.adoc[_» more..._]#

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`.


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

[.small]#xref:bsl/format-0e.adoc[_» more..._]#

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`.


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

[.small]#xref:bsl/format-0ce.adoc[_» more..._]#

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc` and return the result. In the event of an error throw the exception `format_error`.


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

[.small]#xref:bsl/format-09.adoc[_» more..._]#

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc` and return the result. In the event of an error throw the exception `format_error`.


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

[.small]#xref:bsl/format-0a.adoc[_» more..._]#

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc`, using the specified `allocator` to supply memory (if required), and return the result. In the event of an error throw the exception `format_error`.


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

[.small]#xref:bsl/format-0d.adoc[_» more..._]#

Format the specified `args` according to the specification given by the specified `fmtStr` in the locale of the specified `loc`, using the specified `allocator` to supply memory (if required), and return the result. In the event of an error throw the exception `format_error`.


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

[.small]#xref:bsl/format-0cb.adoc[_» more..._]#


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