doc/html/boost/xpressive/regex_error.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct regex_error</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.regex_error_hpp" title="Header &lt;boost/xpressive/regex_error.hpp&gt;">
<link rel="prev" href="regex_constants/error_type.html" title="Type error_type">
<link rel="next" href="../../BOOST_XPR_ENSURE_.html" title="Macro BOOST_XPR_ENSURE_">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="regex_constants/error_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.regex_error_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_XPR_ENSURE_.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.xpressive.regex_error"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct regex_error</span></h2>
<p>boost::xpressive::regex_error &#8212; The class <a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a> defines the type of objects thrown as exceptions to report errors during the conversion from a string representing a regular expression to a finite state machine. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../xpressive/reference.html#header.boost.xpressive.regex_error_hpp" title="Header &lt;boost/xpressive/regex_error.hpp&gt;">boost/xpressive/regex_error.hpp</a>&gt;

</span>
<span class="keyword">struct</span> <a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">runtime_error</span>, <span class="keyword">public</span> <span class="identifier">exception</span> <span class="special">{</span>
  <span class="comment">// <a class="link" href="regex_error.html#boost.xpressive.regex_errorconstruct-copy-destruct">construct/copy/destruct</a></span>
  <span class="keyword">explicit</span> <a class="link" href="regex_error.html#idp1010424416-bb"><span class="identifier">regex_error</span></a><span class="special">(</span><span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">error_type</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="regex_error.html#idp1010430560-bb"><span class="special">~</span><span class="identifier">regex_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="regex_error.html#idp1010421264-bb">public member functions</a></span>
  <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">error_type</span> <a class="link" href="regex_error.html#idp1010421824-bb"><span class="identifier">code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp715816992"></a><h2>Description</h2>
<div class="refsect2">
<a name="idp715817408"></a><h3>
<a name="boost.xpressive.regex_errorconstruct-copy-destruct"></a><code class="computeroutput">regex_error</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp1010424416-bb"></a><span class="identifier">regex_error</span><span class="special">(</span><span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">error_type</span> code<span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> str <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs an object of class <code class="computeroutput"><a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a></code>. 

</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">code</code></span></p></td>
<td><p>The error_type this <code class="computeroutput"><a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a></code> represents. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">str</code></span></p></td>
<td><p>The message string of this <code class="computeroutput"><a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a></code>. </p></td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr>
<td><p><span class="term">Postconditions:</span></p></td>
<td><p>code() == code </p></td>
</tr>
</tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp1010430560-bb"></a><span class="special">~</span><span class="identifier">regex_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Destructor for class <code class="computeroutput"><a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a></code> 
</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Throws:</span></p></td>
<td>Will not throw.</td>
</tr></tbody>
</table></div>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp715845872"></a><h3>
<a name="idp1010421264-bb"></a><code class="computeroutput">regex_error</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">error_type</span> <a name="idp1010421824-bb"></a><span class="identifier">code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Accessor for the error_type value 

</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>the error_type code passed to the constructor </p></td>
</tr>
<tr>
<td><p><span class="term">Throws:</span></p></td>
<td>Will not throw.</td>
</tr>
</tbody>
</table></div>
</li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2007 Eric Niebler<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="regex_constants/error_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.regex_error_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_XPR_ENSURE_.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>