Imported Upstream version 1.64.0
[platform/upstream/boost.git] / doc / html / boost / interprocess / interprocess_exception.html
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=US-ASCII">
5 <title>Class interprocess_exception</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="../../interprocess/indexes_reference.html#header.boost.interprocess.exceptions_hpp" title="Header &lt;boost/interprocess/exceptions.hpp&gt;">
10 <link rel="prev" href="open_copy_on_write.html" title="Global open_copy_on_write">
11 <link rel="next" href="lock_exception.html" title="Class lock_exception">
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="open_copy_on_write.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.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="lock_exception.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.interprocess.interprocess_exception"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class interprocess_exception</span></h2>
30 <p>boost::interprocess::interprocess_exception</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="../../interprocess/indexes_reference.html#header.boost.interprocess.exceptions_hpp" title="Header &lt;boost/interprocess/exceptions.hpp&gt;">boost/interprocess/exceptions.hpp</a>&gt;
34
35 </span>
36 <span class="keyword">class</span> <a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">exception</span> <span class="special">{</span>
37 <span class="keyword">public</span><span class="special">:</span>
38   <span class="comment">// <a class="link" href="interprocess_exception.html#boost.interprocess.interprocess_exceptionconstruct-copy-destruct">construct/copy/destruct</a></span>
39   <a class="link" href="interprocess_exception.html#idp43539296-bb"><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
40   <a class="link" href="interprocess_exception.html#idp43540272-bb"><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">error_info</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
41   <a class="link" href="interprocess_exception.html#idp43542224-bb"><span class="special">~</span><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
42
43   <span class="comment">// <a class="link" href="interprocess_exception.html#idp43534944-bb">public member functions</a></span>
44   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="interprocess_exception.html#idp43535504-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
45   <span class="identifier">native_error_t</span> <a class="link" href="interprocess_exception.html#idp43536896-bb"><span class="identifier">get_native_error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
46   <span class="identifier">error_code_t</span> <a class="link" href="interprocess_exception.html#idp43538016-bb"><span class="identifier">get_error_code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
47 <span class="special">}</span><span class="special">;</span></pre></div>
48 <div class="refsect1">
49 <a name="idp278956864"></a><h2>Description</h2>
50 <p>This class is the base class of all exceptions thrown by boost::interprocess </p>
51 <div class="refsect2">
52 <a name="idp278957632"></a><h3>
53 <a name="boost.interprocess.interprocess_exceptionconstruct-copy-destruct"></a><code class="computeroutput">interprocess_exception</code> 
54         public
55        construct/copy/destruct</h3>
56 <div class="orderedlist"><ol class="orderedlist" type="1">
57 <li class="listitem"><pre class="literallayout"><a name="idp43539296-bb"></a><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> err<span class="special">)</span><span class="special">;</span></pre></li>
58 <li class="listitem"><pre class="literallayout"><a name="idp43540272-bb"></a><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">error_info</span> <span class="special">&amp;</span> err_info<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> str <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li>
59 <li class="listitem"><pre class="literallayout"><a name="idp43542224-bb"></a><span class="special">~</span><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
60 </ol></div>
61 </div>
62 <div class="refsect2">
63 <a name="idp278979408"></a><h3>
64 <a name="idp43534944-bb"></a><code class="computeroutput">interprocess_exception</code> public member functions</h3>
65 <div class="orderedlist"><ol class="orderedlist" type="1">
66 <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp43535504-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
67 <li class="listitem"><pre class="literallayout"><span class="identifier">native_error_t</span> <a name="idp43536896-bb"></a><span class="identifier">get_native_error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
68 <li class="listitem"><pre class="literallayout"><span class="identifier">error_code_t</span> <a name="idp43538016-bb"></a><span class="identifier">get_error_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
69 </ol></div>
70 </div>
71 </div>
72 </div>
73 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
74 <td align="left"></td>
75 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
76         Distributed under the Boost Software License, Version 1.0. (See accompanying
77         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>)
78       </p>
79 </div></td>
80 </tr></table>
81 <hr>
82 <div class="spirit-nav">
83 <a accesskey="p" href="open_copy_on_write.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.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="lock_exception.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
84 </div>
85 </body>
86 </html>