libs/log/doc/html/boost/log/make_exc_idm45185968675792.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template make_exception_handler</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.Log v2">
   8 <link rel="up" href="../../utilities.html#header.boost.log.utility.exception_handler_hpp" title="Header &lt;boost/log/utility/exception_handler.hpp&gt;">
   9 <link rel="prev" href="make_exc_idm45185968681776.html" title="Function template make_exception_handler">
  10 <link rel="next" href="make_exc_idm45185968668288.html" title="Function template make_exception_handler">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="make_exc_idm45185968681776.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.exception_handler_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="make_exc_idm45185968668288.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.make_exc_idm45185968675792"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Function template make_exception_handler</span></h2>
  22 <p>boost::log::make_exception_handler</p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <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="../../utilities.html#header.boost.log.utility.exception_handler_hpp" title="Header &lt;boost/log/utility/exception_handler.hpp&gt;">boost/log/utility/exception_handler.hpp</a>&gt;
  26
  27 </span>
  28 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HandlerT<span class="special">&gt;</span>
  29   <a class="link" href="nothrow_exception_handler.html" title="Class template nothrow_exception_handler">nothrow_exception_handler</a><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">HandlerT</span><span class="special">::</span><span class="identifier">exception_types</span><span class="special">,</span> <span class="identifier">HandlerT</span> <span class="special">&gt;</span>
  30   <span class="identifier">make_exception_handler</span><span class="special">(</span><span class="identifier">HandlerT</span> <span class="keyword">const</span> <span class="special">&amp;</span> handler<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></div>
  31 <div class="refsect1">
  32 <a name="idm46436898507056"></a><h2>Description</h2>
  33 <p>The function creates an exception handler functional object. The handler will call to the user-specified functional object with an exception as its argument. If the exception type cannot be identified, the handler will call the user-defined functor with no arguments, instead of propagating exception to the caller.</p>
  34 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</p>
  35 <p>
  36
  37 </p>
  38 <div class="note"><table border="0" summary="Note">
  39 <tr>
  40 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  41 <th align="left">Note</th>
  42 </tr>
  43 <tr><td align="left" valign="top"><p>This form requires the user-defined functional object to have an <code class="computeroutput">exception_types</code> nested type. This type should be an MPL sequence of all expected exception types. </p></td></tr>
  44 </table></div>
  45 <p>
  46 </p>
  47 <div class="variablelist"><table border="0" class="variablelist compact">
  48 <colgroup>
  49 <col align="left" valign="top">
  50 <col>
  51 </colgroup>
  52 <tbody>
  53 <tr>
  54 <td><p><span class="term">Parameters:</span></p></td>
  55 <td><div class="variablelist"><table border="0" class="variablelist compact">
  56 <colgroup>
  57 <col align="left" valign="top">
  58 <col>
  59 </colgroup>
  60 <tbody><tr>
  61 <td><p><span class="term"><code class="computeroutput">handler</code></span></p></td>
  62 <td><p>User-defined functional object that will receive exceptions. </p></td>
  63 </tr></tbody>
  64 </table></div></td>
  65 </tr>
  66 <tr>
  67 <td><p><span class="term">Returns:</span></p></td>
  68 <td><p>A nullary functional object that should be called from within a <code class="computeroutput">catch</code> statement.</p></td>
  69 </tr>
  70 </tbody>
  71 </table></div>
  72 </div>
  73 </div>
  74 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  75 <td align="left"></td>
  76 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  77         Distributed under the Boost Software License, Version 1.0. (See accompanying
  78         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>).
  79       </p>
  80 </div></td>
  81 </tr></table>
  82 <hr>
  83 <div class="spirit-nav">
  84 <a accesskey="p" href="make_exc_idm45185968681776.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.exception_handler_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="make_exc_idm45185968668288.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  85 </div>
  86 </body>
  87 </html>