exception/doc/enable_current_exception.html

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
<head>
	<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
	<title>enable_current_exception</title>
	<link href='reno.css' type='text/css' rel='stylesheet'/>
</head>
<body>
<div class="body-0">
<div class="body-1">
<div class="body-2">
<div>
<div id="boost_logo">
<a href="http://www.boost.org"><img style="border:0" src="http://www.boost.org/boost.png" alt="Boost" width="277" height="86"/></a>
</div>
<h1>Boost Exception</h1>
</div>
<!-- Copyright (c) 2006-2008 Emil Dotchevski and Reverge Studios, Inc. -->
<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
<div class="RenoIncludeDIV"><h3>enable_current_exception()</h3>
<div class="RenoIncludeDIV"><p><tt>#include &lt;<span class="RenoLink"><a href="exception_enable_exception_cloning_hpp.html">boost/exception/enable_current_exception.hpp</a></span>&gt;</tt></p>
<pre>namespace
boost
    {
<span class="RenoIncludeSPAN">    template &lt;class T&gt;
    ---unspecified--- <span class="RenoLink"><a href="enable_current_exception.html">enable_current_exception</a></span>( T const &amp; e );</span>
    }</pre>
</div><h4>Requirements:</h4>
<p><tt>T</tt> must have an accessible no-throw copy constructor</p>
<h4>Returns:</h4>
<p>An object of <i>unspecified</i> type which derives publicly from <tt>T</tt>. That is, the returned object can be intercepted by a <tt>catch(T &amp;)</tt>.</p>
<h4>Description:</h4>
<p>This function is designed to be used directly in a throw-expression to enable the cloning support in Boost Exception. For example:</p>
<pre>class
my_exception:
    public std::exception
    {
    };

....
throw boost::<span class="RenoLink"><a href="enable_current_exception.html">enable_current_exception</a></span>(my_exception());</pre>
<p>Unless <tt><span class="RenoLink"><a href="enable_current_exception.html">enable_current_exception</a></span>()</tt> is called at the time an exception object is used in a throw-expression, an attempt to copy it using <tt><span class="RenoLink"><a href="current_exception.html">current_exception</a></span>()</tt> may return an <tt><span class="RenoLink"><a href="exception_ptr.html">exception_ptr</a></span></tt> which refers to an instance of <tt><span class="RenoLink"><a href="unknown_exception.html">unknown_exception</a></span></tt>. See <tt><span class="RenoLink"><a href="current_exception.html">current_exception</a></span>()</tt> for details.</p>
<h4>Note:</h4>
<p>Instead of using the <tt>throw</tt> keyword directly, it is preferable to call <tt>boost::<span class="RenoLink"><a href="throw_exception.html">throw_exception</a></span>()</tt>. This is guaranteed to throw an exception that derives from <tt>boost::<span class="RenoLink"><a href="exception.html">exception</a></span></tt> and supports cloning.</p>
</div><h3>See also:</h3>
<div class="RenoPageList"><a href="boost-exception.html">Boost Exception<br/>
</a><a href="current_exception.html">current_exception<br/>
</a><a href="cloning.html">Tutorial: Transporting of Exceptions between Threads<br/>
</a><a href="throw_exception.html">throw_exception<br/>
</a></div>
<!-- Copyright (c) 2006-2008 Emil Dotchevski and Reverge Studios, Inc. -->
<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
<div id="footer">
<p>&nbsp;</p>
<hr/>
<p>
<a class="logo" href="http://jigsaw.w3.org/css-validator/validator?uri=http://revergestudios.com/boost-exception/reno.css"><img class="logo_pic" src="valid-css.png" alt="Valid CSS" height="31" width="88"/></a>
<a class="logo" href="http://validator.w3.org/check?uri=referer"><img class="logo_pic" src="valid-xhtml.png" alt="Valid XHTML 1.0" height="31" width="88"/></a>
<small>Copyright (c) 2006-2008 by Emil Dotchevski and Reverge Studios, Inc.<br/>
Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>
</p>
</div>
</div>
</div>
</div>
</body>
</html>
Boost Exception documentation update [SVN r44444] 2008-04-15 21:56:34 +00:00			`<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'`
			`'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>`
			`<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>`
			`<head>`
			`<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>`
			`<title>enable_current_exception</title>`
			`<link href='reno.css' type='text/css' rel='stylesheet'/>`
			`</head>`
			`<body>`
			`<div class="body-0">`
			`<div class="body-1">`
			`<div class="body-2">`
			`<div>`
			`<div id="boost_logo">`
			`<a href="http://www.boost.org"><img style="border:0" src="http://www.boost.org/boost.png" alt="Boost" width="277" height="86"/></a>`
			`</div>`
			`<h1>Boost Exception</h1>`
			`</div>`
minor documentation fixes. [SVN r44476] 2008-04-16 22:55:19 +00:00			`<!-- Copyright (c) 2006-2008 Emil Dotchevski and Reverge Studios, Inc. -->`
			`<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->`
			`<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->`
Boost Exception documentation update [SVN r44444] 2008-04-15 21:56:34 +00:00			`<div class="RenoIncludeDIV"><h3>enable_current_exception()</h3>`
			`<div class="RenoIncludeDIV"><p><tt>#include <<span class="RenoLink"><a href="exception_enable_exception_cloning_hpp.html">boost/exception/enable_current_exception.hpp</a></span>></tt></p>`
			`<pre>namespace`
			`boost`
			`{`
			`<span class="RenoIncludeSPAN"> template <class T>`
			`---unspecified--- <span class="RenoLink"><a href="enable_current_exception.html">enable_current_exception</a></span>( T const & e );</span>`
			`}</pre>`
			`</div><h4>Requirements:</h4>`
			`<p><tt>T</tt> must have an accessible no-throw copy constructor</p>`
			`<h4>Returns:</h4>`
			`<p>An object of <i>unspecified</i> type which derives publicly from <tt>T</tt>. That is, the returned object can be intercepted by a <tt>catch(T &)</tt>.</p>`
			`<h4>Description:</h4>`
			`<p>This function is designed to be used directly in a throw-expression to enable the cloning support in Boost Exception. For example:</p>`
			`<pre>class`
			`my_exception:`
			`public std::exception`
			`{`
			`};`

			`....`
			`throw boost::<span class="RenoLink"><a href="enable_current_exception.html">enable_current_exception</a></span>(my_exception());</pre>`
minor documentation fixes. [SVN r44476] 2008-04-16 22:55:19 +00:00			<p>Unless <tt><span class="RenoLink"><a href="enable_current_exception.html">enable_current_exception</a></span>()</tt> is called at the time an exception object is used in a throw-expression, an attempt to copy it using <tt><span class="RenoLink"><a href="current_exception.html">current_exception</a></span>()</tt> may return an <tt><span class="RenoLink"><a href="exception_ptr.html">exception_ptr</a></span></tt> which refers to an instance of <tt><span class="RenoLink"><a href="unknown_exception.html">unknown_exception</a></span></tt>. See <tt><span class="RenoLink"><a href="current_exception.html">current_exception</a></span>()</tt> for details.</p>
Boost Exception documentation update [SVN r44444] 2008-04-15 21:56:34 +00:00			`<h4>Note:</h4>`
			`<p>Instead of using the <tt>throw</tt> keyword directly, it is preferable to call <tt>boost::<span class="RenoLink"><a href="throw_exception.html">throw_exception</a></span>()</tt>. This is guaranteed to throw an exception that derives from <tt>boost::<span class="RenoLink"><a href="exception.html">exception</a></span></tt> and supports cloning.</p>`
			`</div><h3>See also:</h3>`
			`<div class="RenoPageList"><a href="boost-exception.html">Boost Exception<br/>`
			`</a><a href="current_exception.html">current_exception<br/>`
			`</a><a href="cloning.html">Tutorial: Transporting of Exceptions between Threads<br/>`
			`</a><a href="throw_exception.html">throw_exception<br/>`
			`</a></div>`
minor documentation fixes. [SVN r44476] 2008-04-16 22:55:19 +00:00			`<!-- Copyright (c) 2006-2008 Emil Dotchevski and Reverge Studios, Inc. -->`
			`<!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->`
			`<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->`
Boost Exception documentation update [SVN r44444] 2008-04-15 21:56:34 +00:00			`<div id="footer">`
			`<p> </p>`
			`<hr/>`
			`<p>`
			`<a class="logo" href="http://jigsaw.w3.org/css-validator/validator?uri=http://revergestudios.com/boost-exception/reno.css"><img class="logo_pic" src="valid-css.png" alt="Valid CSS" height="31" width="88"/></a>`
			`<a class="logo" href="http://validator.w3.org/check?uri=referer"><img class="logo_pic" src="valid-xhtml.png" alt="Valid XHTML 1.0" height="31" width="88"/></a>`
			`<small>Copyright (c) 2006-2008 by Emil Dotchevski and Reverge Studios, Inc.<br/>`
			`Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>`
			`</p>`
			`</div>`
			`</div>`
			`</div>`
			`</div>`
			`</body>`
			`</html>`