[#bsl-vformat-06]
= xref:bsl.adoc[bsl]::vformat
:relfileprefix: ../
:mrdocs:

`vformat` overloads

== Synopses

Declared in `<bslfmt_format.h>`

Format `args` according to the specification in `fmtStr`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/string.adoc[bsl::string]
xref:bsl/vformat-0e8.adoc[vformat](
    std::string_view fmtStr,
    std::format_args args);
----

[.small]#xref:bsl/vformat-0e8.adoc[_» more..._]#

Format `args` according to the specification in `fmtStr`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/wstring.adoc[bsl::wstring]
xref:bsl/vformat-007.adoc[vformat](
    std::wstring_view fmtStr,
    std::wformat_args args);
----

[.small]#xref:bsl/vformat-007.adoc[_» more..._]#

Format `args` according to `fmtStr` using the given allocator.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/string.adoc[bsl::string]
xref:bsl/vformat-0eb.adoc[vformat](
    xref:bsl/allocator-0df.adoc[allocator<char>] alloc,
    std::string_view fmtStr,
    std::format_args args);
----

[.small]#xref:bsl/vformat-0eb.adoc[_» more..._]#

Format `args` according to `fmtStr` using the given allocator.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/wstring.adoc[bsl::wstring]
xref:bsl/vformat-0c3.adoc[vformat](
    xref:bsl/allocator-0df.adoc[allocator<wchar_t>] alloc,
    std::wstring_view fmtStr,
    std::wformat_args args);
----

[.small]#xref:bsl/vformat-0c3.adoc[_» more..._]#

Format `args` according to `fmtStr` using the given locale.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/string.adoc[bsl::string]
xref:bsl/vformat-08.adoc[vformat](
    std::locale const& loc,
    std::string_view fmtStr,
    std::format_args args);
----

[.small]#xref:bsl/vformat-08.adoc[_» more..._]#

Format `args` according to `fmtStr` using locale `loc`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/wstring.adoc[bsl::wstring]
xref:bsl/vformat-0c2.adoc[vformat](
    std::locale const& loc,
    std::wstring_view fmtStr,
    std::wformat_args args);
----

[.small]#xref:bsl/vformat-0c2.adoc[_» more..._]#

Format `args` according to `fmtStr` using allocator and locale.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/string.adoc[bsl::string]
xref:bsl/vformat-00b.adoc[vformat](
    xref:bsl/allocator-0df.adoc[allocator<char>] alloc,
    std::locale const& loc,
    std::string_view fmtStr,
    std::format_args args);
----

[.small]#xref:bsl/vformat-00b.adoc[_» more..._]#

Format `args` according to `fmtStr` using allocator and locale.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/wstring.adoc[bsl::wstring]
xref:bsl/vformat-0ef.adoc[vformat](
    xref:bsl/allocator-0df.adoc[allocator<wchar_t>] alloc,
    std::locale const& loc,
    std::wstring_view fmtStr,
    std::wformat_args args);
----

[.small]#xref:bsl/vformat-0ef.adoc[_» more..._]#

== Return Value

* the formatted string
* the formatted wide string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *fmtStr*
| format string
| *args*
| type‐erased format arguments
| *alloc*
| allocator used to supply memory
| *loc*
| locale used for locale‐dependent formatting
|===


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