Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/doc/html/boost/xpressive/regex_search.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 16 years ago

updated boost from 1_33_1 to 1_34_1
File size: 9.1 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Function regex_search</title>
5<link rel="stylesheet" href="../../boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7<link rel="start" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8<link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.regex_algorithms.hpp" title="Header &lt;boost/xpressive/regex_algorithms.hpp&gt;">
9<link rel="prev" href="regex_match.html" title="Function regex_match">
10<link rel="next" href="regex_replace.html" title="Function regex_replace">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
15<td align="center"><a href="../../../../index.htm">Home</a></td>
16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../../../people/people.htm">People</a></td>
18<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="regex_match.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.regex_algorithms.hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="regex_replace.html"><img src="../../images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="boost.xpressive.regex_search"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function regex_search</span></h2>
29<p>boost::xpressive::regex_search &#8212; Determines whether there is some sub-sequence within [begin,end) that matches the regular expression re. </p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
33<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> OtherBidiIter, <span class="bold"><strong>typename</strong></span> BidiIter&gt; 
34  <span class="type"><span class="bold"><strong>bool</strong></span></span> regex_search(OtherBidiIter begin, OtherBidiIter end,
35                    <a href="match_results.html" title="Struct template match_results">match_results</a>&lt; BidiIter &gt; &amp; what,
36                    <a href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; <span class="bold"><strong>const</strong></span> &amp; re,
37                    regex_constants::match_flag_type flags = regex_constants::match_default);
38<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> OtherBidiIter, <span class="bold"><strong>typename</strong></span> BidiIter&gt; 
39  <span class="type"><span class="bold"><strong>bool</strong></span></span> regex_search(OtherBidiIter begin, OtherBidiIter end,
40                    <a href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; BidiIter &gt; <span class="bold"><strong>const</strong></span> &amp; re,
41                    regex_constants::match_flag_type flags = regex_constants::match_default);
42<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Char&gt; 
43  <span class="type"><span class="bold"><strong>bool</strong></span></span> regex_search(Char <span class="bold"><strong>const</strong></span> * begin, <a href="match_results.html" title="Struct template match_results">match_results</a>&lt; Char <span class="bold"><strong>const</strong></span> * &gt; &amp; what,
44                    <a href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; Char <span class="bold"><strong>const</strong></span> * &gt; <span class="bold"><strong>const</strong></span> &amp; re,
45                    regex_constants::match_flag_type flags = regex_constants::match_default);
46<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Char, <span class="bold"><strong>typename</strong></span> Traits, <span class="bold"><strong>typename</strong></span> Alloc&gt; 
47  <span class="type"><span class="bold"><strong>bool</strong></span></span> regex_search(std::basic_string&lt; Char, Traits, Alloc &gt; <span class="bold"><strong>const</strong></span> &amp; str,
48                    <a href="match_results.html" title="Struct template match_results">match_results</a>&lt; <span class="bold"><strong>typename</strong></span> std::basic_string&lt; Char, Traits, Alloc &gt;::const_iterator &gt; &amp; what,
49                    <a href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; <span class="bold"><strong>typename</strong></span> std::basic_string&lt; Char, Traits, Alloc &gt;::const_iterator &gt; <span class="bold"><strong>const</strong></span> &amp; re,
50                    regex_constants::match_flag_type flags = regex_constants::match_default);
51<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Char&gt; 
52  <span class="type"><span class="bold"><strong>bool</strong></span></span> regex_search(Char <span class="bold"><strong>const</strong></span> * begin,
53                    <a href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; Char <span class="bold"><strong>const</strong></span> * &gt; <span class="bold"><strong>const</strong></span> &amp; re,
54                    regex_constants::match_flag_type flags = regex_constants::match_default);
55<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Char, <span class="bold"><strong>typename</strong></span> Traits, <span class="bold"><strong>typename</strong></span> Alloc&gt; 
56  <span class="type"><span class="bold"><strong>bool</strong></span></span> regex_search(std::basic_string&lt; Char, Traits, Alloc &gt; <span class="bold"><strong>const</strong></span> &amp; str,
57                    <a href="basic_regex.html" title="Struct template basic_regex">basic_regex</a>&lt; <span class="bold"><strong>typename</strong></span> std::basic_string&lt; Char, Traits, Alloc &gt;::const_iterator &gt; <span class="bold"><strong>const</strong></span> &amp; re,
58                    regex_constants::match_flag_type flags = regex_constants::match_default);</pre></div>
59<div class="refsect1" lang="en">
60<a name="id2023725"></a><h2>Description</h2>
61<p>Determines whether there is some sub-sequence within [begin,end) that matches the regular expression re.</p>
62<p>
63
64
65
66</p>
67<div class="variablelist"><table border="0">
68<col align="left" valign="top">
69<tbody>
70<tr>
71<td>
72<span class="term">Parameters:</span></td>
73<td><div class="variablelist"><table border="0">
74<col align="left" valign="top">
75<tbody>
76<tr>
77<td>
78<span class="term"><code class="computeroutput">begin</code></span></td>
79<td><p>The beginning of the sequence </p></td>
80</tr>
81<tr>
82<td>
83<span class="term"><code class="computeroutput">end</code></span></td>
84<td><p>The end of the sequence </p></td>
85</tr>
86<tr>
87<td>
88<span class="term"><code class="computeroutput">flags</code></span></td>
89<td><p>Optional match flags, used to control how the expression is matched against the sequence. (See match_flag_type.) </p></td>
90</tr>
91<tr>
92<td>
93<span class="term"><code class="computeroutput">re</code></span></td>
94<td><p>The regular expression object to use </p></td>
95</tr>
96<tr>
97<td>
98<span class="term"><code class="computeroutput">what</code></span></td>
99<td><p>The match_results struct into which the sub_matches will be written </p></td>
100</tr>
101</tbody>
102</table></div></td>
103</tr>
104<tr>
105<td>
106<span class="term">Requires:</span></td>
107<td>
108<p>Types BidiIter and OtherBidiIter meet the requirements of a Bidirectional Iterator (24.1.4). </p>
109<p>OtherBidiIter is convertible to BidiIter. </p>
110<p>[begin,end) denotes a valid iterator range. </p>
111</td>
112</tr>
113<tr>
114<td>
115<span class="term">Returns:</span></td>
116<td><p>true if a match is found, false otherwise </p></td>
117</tr>
118<tr>
119<td>
120<span class="term">Throws:</span></td>
121<td>
122<a href="regex_error.html" title="Struct regex_error">regex_error</a> on stack exhaustion </td>
123</tr>
124</tbody>
125</table></div>
126</div>
127</div>
128<table width="100%"><tr>
129<td align="left"></td>
130<td align="right"><small>Copyright © 2003, 2004 Eric Niebler</small></td>
131</tr></table>
132<hr>
133<div class="spirit-nav">
134<a accesskey="p" href="regex_match.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.regex_algorithms.hpp"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="regex_replace.html"><img src="../../images/next.png" alt="Next"></a>
135</div>
136</body>
137</html>
Note: See TracBrowser for help on using the repository browser.