std::match_results::format

 

C++

Language

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Regular expressions library

Classes

basic_regex (C++11)

sub_match (C++11)

match_results (C++11)

Algorithms

regex_match (C++11)

regex_search (C++11)

regex_replace (C++11)

Iterators

regex_iterator (C++11)

regex_token_iterator (C++11)

Exceptions

regex_error (C++11)

Traits

regex_traits (C++11)

Constants

syntax_option_type (C++11)

match_flag_type (C++11)

error_type (C++11)

 

std::match_results

Member functions

match_results::match_results

match_results::~match_results

match_results::operator=

match_results::get_allocator

State

match_results::ready

Element access

match_results::size

match_results::max_size

match_results::empty

match_results::length

match_results::position

match_results::str

match_results::operator_at

match_results::prefix

match_results::suffix

Iterators

match_results::begin match_results::cbegin

match_results::end match_results::cend

Format

match_results::format

Modifiers

match_results::swap

 

template< class OutputIt > OutputIter format( OutputIt out,                    const char_type* fmt_first, const char_type* fmt_last,                    std::regex_constants::match_flag_type flags =                        std::regex_constants::format_default ) const;	(1)	(since C++11)
template< class OutputIt, class ST, class SA > OutputIter format( OutputIt out,                    const basic_string<char_type,ST,SA>& fmt,                    std::regex_constants::match_flag_type flags =                        std::regex_constants::format_default ) const;	(2)	(since C++11)
template< class ST, class SA > std::basic_string<char_type,ST,SA>     format( const std::basic_string<char_type,ST,SA>& fmt,             std::regex_constants::match_flag_type flags =                 std::regex_constants::format_default ) const;	(3)	(since C++11)
string_type format( const char_type* fmt_s,                     std::regex_constants::match_flag_type flags =                         std::regex_constants::format_default ) const;	(4)	(since C++11)

Copies the given format character sequence replacing each format specifier or escape sequence with either the characters it represents or characters within *this to which it refers to. The bitmasks specified by flags determine which format specifiers and escape sequences are recognized.

The behavior is undefined if ready() != true.

1) The format character sequence is defined by the range [fmt_first, fmt_last). The resulting character sequence is copied to out.

2) The format character sequence is defined by the characters in fmt. The resulting character sequence is copied to out.

3-4) The format character sequence is defined by the characters in fmt and fmt_s respectively. The resulting character sequence is copied to a newly constructed string, which is returned.

Parameters

fmt_begin, fmt_end	-	pointers to a range of characters defining the format character sequence
fmt	-	string defining the format character sequence
fmt_s	-	pointer to a null-terminated character string defining the format character sequence
out	-	iterator where to copy the resulting character sequence to
flags	-	bitmask type specifying which format specifiers and escape sequences are recognized
Type requirements
- OutputIt must meet the requirements of OutputIterator.

Return value

1-2) out

3-4) The newly constructed string containing resulting character sequence.

Exceptions

(none)