• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Class ptree_error</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header &lt;boost/property_tree/exceptions.hpp&gt;">
10<link rel="prev" href="ptree_bad_path.html" title="Class ptree_bad_path">
11<link rel="next" href="translat_1_3_32_10_2_1_1_1.html" title="Struct template translator_between&lt;std::basic_string&lt; Ch, Traits, Alloc &gt;, std::basic_string&lt; Ch, Traits, Alloc &gt;&gt;">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="ptree_bad_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_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="translat_1_3_32_10_2_1_1_1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.property_tree.ptree_error"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class ptree_error</span></h2>
30<p>boost::property_tree::ptree_error — Base class for all property tree errors. Derives from <code class="computeroutput">std::runtime_error</code>. Call member function <code class="computeroutput">what</code> to get human readable message associated with the error. </p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<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="../../property_tree/reference.html#header.boost.property_tree.exceptions_hpp" title="Header &lt;boost/property_tree/exceptions.hpp&gt;">boost/property_tree/exceptions.hpp</a>&gt;
34
35</span>
36<span class="keyword">class</span> <a class="link" href="ptree_error.html" title="Class ptree_error">ptree_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">runtime_error</span> <span class="special">{</span>
37<span class="keyword">public</span><span class="special">:</span>
38  <span class="comment">// <a class="link" href="ptree_error.html#boost.property_tree.ptree_errorconstruct-copy-destruct">construct/copy/destruct</a></span>
39  <a class="link" href="ptree_error.html#id-1_3_32_10_1_1_1_3_4-bb"><span class="identifier">ptree_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
40  <a class="link" href="ptree_error.html#id-1_3_32_10_1_1_1_3_5-bb"><span class="special">~</span><span class="identifier">ptree_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
41<span class="special">}</span><span class="special">;</span></pre></div>
42<div class="refsect1">
43<a name="id-1.3.32.10.2.5.4"></a><h2>Description</h2>
44<div class="refsect2">
45<a name="id-1.3.32.10.2.5.4.2"></a><h3>
46<a name="boost.property_tree.ptree_errorconstruct-copy-destruct"></a><code class="computeroutput">ptree_error</code>
47        public
48       construct/copy/destruct</h3>
49<div class="orderedlist"><ol class="orderedlist" type="1">
50<li class="listitem">
51<pre class="literallayout"><a name="id-1_3_32_10_1_1_1_3_4-bb"></a><span class="identifier">ptree_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> what<span class="special">)</span><span class="special">;</span></pre>Instantiate a <code class="computeroutput"><a class="link" href="ptree_error.html" title="Class ptree_error">ptree_error</a></code> instance with the given message. <p>
52</p>
53<div class="variablelist"><table border="0" class="variablelist compact">
54<colgroup>
55<col align="left" valign="top">
56<col>
57</colgroup>
58<tbody><tr>
59<td><p><span class="term">Parameters:</span></p></td>
60<td><div class="variablelist"><table border="0" class="variablelist compact">
61<colgroup>
62<col align="left" valign="top">
63<col>
64</colgroup>
65<tbody><tr>
66<td><p><span class="term"><code class="computeroutput">what</code></span></p></td>
67<td><p>The message to associate with this error. </p></td>
68</tr></tbody>
69</table></div></td>
70</tr></tbody>
71</table></div>
72</li>
73<li class="listitem"><pre class="literallayout"><a name="id-1_3_32_10_1_1_1_3_5-bb"></a><span class="special">~</span><span class="identifier">ptree_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
74</ol></div>
75</div>
76</div>
77</div>
78<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
79<td align="left"></td>
80<td align="right"><div class="copyright-footer">Copyright © 2008-2010 Marcin Kalicinski<br>Copyright © 2010-2013 Sebastian
81      Redl<p>
82        Distributed under the Boost Software License, Version 1.0. (See accompanying
83        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>)
84      </p>
85</div></td>
86</tr></table>
87<hr>
88<div class="spirit-nav">
89<a accesskey="p" href="ptree_bad_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.exceptions_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="translat_1_3_32_10_2_1_1_1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
90</div>
91</body>
92</html>
93