Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / contract / doc / html / boost / contract / except_failure.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Function except_failure</title>
5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
8 <link rel="up" href="../../reference.html#header.boost.contract.core.exception_hpp" title="Header &lt;boost/contract/core/exception.hpp&gt;">
9 <link rel="prev" href="get_except_failure.html" title="Function get_except_failure">
10 <link rel="next" href="set_old_failure.html" title="Function set_old_failure">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="get_except_failure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.exception_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="set_old_failure.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="boost.contract.except_failure"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Function except_failure</span></h2>
29 <p>boost::contract::except_failure &#8212; Call failure handler for exception guarantees. </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"><span class="comment">// In header: &lt;<a class="link" href="../../reference.html#header.boost.contract.core.exception_hpp" title="Header &lt;boost/contract/core/exception.hpp&gt;">boost/contract/core/exception.hpp</a>&gt;
33
34 </span>
35 <span class="keyword">void</span> <span class="identifier">except_failure</span><span class="special">(</span><span class="identifier">from</span> where<span class="special">)</span><span class="special">;</span></pre></div>
36 <div class="refsect1">
37 <a name="idm45707995803856"></a><h2>Description</h2>
38 <p>This is often called only internally by this library.</p>
39 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify a failure handler that throws exceptions on contract assertion failures (not the default), however:</p>
40 <div class="warning"><table border="0" summary="Warning">
41 <tr>
42 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/src/images/warning.png"></td>
43 <th align="left">Warning</th>
44 </tr>
45 <tr><td align="left" valign="top"><p>When this failure handler is called there is already an active exception (the one that caused the exception guarantees to be checked in the first place). Therefore, programming this failure handler to throw yet another exception will force C++ to automatically terminate the program.</p></td></tr>
46 </table></div>
47 <p>
48
49 </p>
50 <p><span class="bold"><strong>See Also:</strong></span></p>
51 <p> <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)"> Throw on Failure</a>,  <a class="link" href="../../boost_contract/tutorial.html#boost_contract.tutorial.exception_guarantees" title="Exception Guarantees"> Exception Guarantees</a> </p>
52 <p>
53 </p>
54 <p>
55 </p>
56 <div class="variablelist"><table border="0" class="variablelist compact">
57 <colgroup>
58 <col align="left" valign="top">
59 <col>
60 </colgroup>
61 <tbody><tr>
62 <td><p><span class="term">Parameters:</span></p></td>
63 <td><div class="variablelist"><table border="0" class="variablelist compact">
64 <colgroup>
65 <col align="left" valign="top">
66 <col>
67 </colgroup>
68 <tbody><tr>
69 <td><p><span class="term"><code class="computeroutput">where</code></span></p></td>
70 <td><p>Operation that failed the contract assertion.</p></td>
71 </tr></tbody>
72 </table></div></td>
73 </tr></tbody>
74 </table></div>
75 </div>
76 </div>
77 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
78 <td align="left"></td>
79 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
80         Distributed under the Boost Software License, Version 1.0 (see accompanying
81         file LICENSE_1_0.txt or a copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
82       </p>
83 </div></td>
84 </tr></table>
85 <hr>
86 <div class="spirit-nav">
87 <a accesskey="p" href="get_except_failure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.exception_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="set_old_failure.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
88 </div>
89 </body>
90 </html>