View source for cpp/utility/format/vformat

You do not have permission to edit this page, for the following reasons:

The action you have requested is limited to users in one of the groups: Users, Administrators.

Due to recent vandalism, editing of this page is temporarily disabled for new users.If you want to suggest a change, please leave a message on the suggestions page for new users instead (don't be surprised if that page appears vandalized!).

You can view and copy the source of this page.

{{cpp/title|vformat}}
{{cpp/utility/format/navbar}}

{{dcl begin}}
{{dcl header|format}}
{{dcl|num=1|since=c++20|1=
std::string vformat( std::string_view fmt, std::format_args args );
}}
{{dcl|num=2|since=c++20|1=
std::wstring vformat( std::wstring_view fmt, std::wformat_args args );
}}
{{dcl|num=3|since=c++20|1=
std::string vformat( const std::locale& loc,
                     std::string_view fmt, std::format_args args );
}}
{{dcl|num=4|since=c++20|1=
std::wstring vformat( const std::locale& loc,
                      std::wstring_view fmt, std::wformat_args args );
}}
{{dcl end}}

Format arguments held by {{c|args}} according to the format string {{c|fmt}}, and return the result as a string. If present, {{c|loc}} is used for locale-specific formatting.

===Parameters===
{{par begin}}
{{par|fmt|{{cpp/utility/format/format string}}}}
{{par|args|arguments to be formatted}}
{{par|loc|{{lc|std::locale}} used for locale-specific formatting}}
{{par end}}

===Return value===
A string object holding the formatted result.

===Exceptions===
Throws {{lc|std::format_error}} if {{c|fmt}} is not a valid format string for the provided arguments, or {{lc|std::bad_alloc}} on allocation failure. Also propagates any exception thrown by formatter or iterator operations.

===Example===
{{example
|code=
#include <format>
#include <iostream>

template<typename... Args>
inline void println(const std::format_string<Args...> fmt, Args&&... args)
{
    std::cout << std::vformat(fmt.get(), std::make_format_args(args...)) << '\n';
}

int main()
{
    println("{}{} {}{}", "Hello", ',', "C++", -1 + 2 * 3 * 4);
}
|output=
Hello, C++23
}}

===See also===

{{langlinks|es|ja|ru|zh}}

Templates used on this page:

Template:(( (view source)
Template:)) (view source)
Template:anchor (view source)
Template:c (view source) (protected)
Template:cpp/navbar content (view source)
Template:cpp/navbar heading (view source)
Template:cpp/text/navbar content (view source)
Template:cpp/text/navbar heading (view source)
Template:cpp/title (view source) (protected)
Template:cpp/utility/format/format string (view source)
Template:cpp/utility/format/navbar (view source)
Template:cpp/utility/format/navbar content (view source)
Template:cpp/utility/format/navbar heading (view source)
Template:ctitle (view source) (protected)
Template:dcl (view source) (protected)
Template:dcl/std (view source) (semi-protected)
Template:dcl begin (view source) (protected)
Template:dcl end (view source) (protected)
Template:dcl header (view source) (protected)
Template:dcl list header/link (view source)
Template:dcl sep (view source) (protected)
Template:dsc editlink (view source)
Template:dsc header/link (view source)
Template:dsc small (view source)
Template:example (view source) (protected)
Template:get lang (view source) (protected)
Template:langlinks (view source) (protected)
Template:langlinks/one (view source) (protected)
Template:lc (view source) (protected)
Template:lines (view source) (protected)
Template:list guard (view source)
Template:ls (view source)
Template:ltt (view source) (protected)
Template:ltt/core (view source) (protected)
Template:mark (view source) (protected)
Template:mark c++11 (view source) (protected)
Template:mark c++17 (view source) (protected)
Template:mark c++20 (view source)
Template:mark c++23 (view source) (protected)
Template:mark c++26 (view source)
Template:mark deprecated c++26 (view source)
Template:mark optional (view source) (protected)
Template:mark rev (view source) (protected)
Template:mark since c++20 (view source)
Template:mark since c++23 (view source)
Template:mark since c++26 (view source)
Template:navbar (view source)
Template:navbar editlink (view source) (protected)
Template:nv (view source) (protected)
Template:nv begin (view source) (protected)
Template:nv col begin (view source) (protected)
Template:nv col end (view source) (protected)
Template:nv end (view source) (protected)
Template:nv h1 (view source) (protected)
Template:nv h2 (view source) (protected)
Template:nv ln (view source) (protected)
Template:par (view source) (protected)
Template:par begin (

cppreference.com

Search

Namespaces

Variants

Views

Actions

View source for cpp/utility/format/vformat