| Home | Libraries | People | FAQ | More

## Function regex_match

boost::xpressive::regex_match — See if a regex matches a sequence from beginning to end.

## Synopsis

    // In header: <boost/xpressive/regex_algorithms.hpp>

    template<typename BidiIter>
      bool regex_match(BidiIter begin, BidiIter end,
                       match_results< BidiIter > & what,
                       basic_regex< BidiIter > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default);
    template<typename BidiIter>
      bool regex_match(BidiIter begin, BidiIter end,
                       basic_regex< BidiIter > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default);
    template<typename Char>
      bool regex_match(Char * begin, match_results< Char * > & what,
                       basic_regex< Char * > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default);
    template<typename BidiRange, typename BidiIter>
      bool regex_match(BidiRange & rng, match_results< BidiIter > & what,
                       basic_regex< BidiIter > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default,
                       unspecified = 0);
    template<typename BidiRange, typename BidiIter>
      bool regex_match(BidiRange const & rng, match_results< BidiIter > & what,
                       basic_regex< BidiIter > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default,
                       unspecified = 0);
    template<typename Char>
      bool regex_match(Char * begin, basic_regex< Char * > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default);
    template<typename BidiRange, typename BidiIter>
      bool regex_match(BidiRange & rng, basic_regex< BidiIter > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default,
                       unspecified = 0);
    template<typename BidiRange, typename BidiIter>
      bool regex_match(BidiRange const & rng, basic_regex< BidiIter > const & re,
                       regex_constants::match_flag_type flags = regex_constants::match_default,
                       unspecified = 0);

## Description

Determines whether there is an exact match between the regular expression `re`, and all of the sequence `[begin, end)`.

Parameters: |
`begin` | The beginning of the sequence.
`end` | The end of the sequence.
`flags` | Optional match flags, used to control how the expression is matched against the sequence. (See `match_flag_type`.)
`re` | The regular expression object to use
`what` | The ``match_results`` struct into which the sub_matches will be written
Requires: | Type `BidiIter` meets the requirements of a Bidirectional Iterator (24.1.4).
Requires: | `[begin,end)` denotes a valid iterator range.
Returns: | `true` if a match is found, `false` otherwise
Throws: | regex_error on stack exhaustion