boostorg/exception
1
0
Fork 1
mirror of https://github.com/boostorg/exception.git synced 2025-07-13 12:36:37 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
f58ffdd643797244cc9c1f3d96c2d81652e540cf
exception/doc/exception.html

111 lines
7.9 KiB
HTML
Raw Normal View History

boost exception [SVN r43485]
2008-03-04 01:41:17 +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>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) -->
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
<div class="RenoIncludeDIV"><h3>exception</h3>
<div class="RenoIncludeDIV"><p><span class="RenoEscape">&#35;<!--<wiki>`&#35;</wiki>--></span>include &lt;<span class="RenoLink"><a href="exception_exception_hpp.html">boost/exception/exception.hpp</a></span>&gt;</p>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
<pre>namespace
boost
{
<span class="RenoIncludeSPAN"> class
<span class="RenoLink"><a href="exception.html">exception</a></span>
{
public:
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
<span class="RenoIncludeSPAN"> virtual char const * <span class="RenoLink"><a href="exception_diagnostic_information.html">diagnostic_information</a></span>() const throw();</span>
<span class="RenoIncludeSPAN"> virtual char const * <span class="RenoLink"><a href="exception_what.html">what</a></span>() const throw();</span>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
protected:
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
<span class="RenoIncludeSPAN"> <span class="RenoLink"><a href="exception_constructors.html">exception</a></span>();
<span class="RenoLink"><a href="exception_constructors.html">exception</a></span>( <span class="RenoLink"><a href="exception.html">exception</a></span> const &amp; x );</span>
<span class="RenoIncludeSPAN"> <span class="RenoLink"><a href="exception_destructor.html">~exception</a></span>();</span>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
};</span>
}</pre>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
</div><p>Class boost::<span class="RenoLink"><a href="exception.html">exception</a></span> is designed to be used as a universal base for user-defined exception types.</p>
<p>An object of any type deriving from boost::<span class="RenoLink"><a href="exception.html">exception</a></span> can store data of arbitrary types, using the <span class="RenoLink"><a href="error_info.html">error_info</a></span> wrapper and <span class="RenoLink"><a href="operator_shl_exception.html">operator&lt;&lt;</a></span>.</p>
<p>To retrieve data from a boost::<span class="RenoLink"><a href="exception.html">exception</a></span> object, use the <span class="RenoLink"><a href="get_error_info.html">get_error_info</a></span> function template.</p>
<div class="RenoIncludeDIV"><h3>exception::exception</h3>
<div class="RenoIncludeDIV"><pre><span class="RenoLink"><a href="exception_constructors.html">exception</a></span>();
<span class="RenoLink"><a href="exception_constructors.html">exception</a></span>( <span class="RenoLink"><a href="exception.html">exception</a></span> const &amp; x );</pre>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
</div><h4>Effects:</h4>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
<div><ul><li> Default constructor: initializes an empty boost::<span class="RenoLink"><a href="exception.html">exception</a></span> object.</li>
<li> Copy constructor: initializes a boost::<span class="RenoLink"><a href="exception.html">exception</a></span> object which shares with x all data added through <span class="RenoLink"><a href="operator_shl_exception.html">operator&lt;&lt;</a></span>, including data that is added at a future time.</li>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
</ul></div>
<h4>Throws:</h4>
<p>Nothing.</p>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
</div><div class="RenoIncludeDIV"><h3>exception::~exception</h3>
<div class="RenoIncludeDIV"><pre><span class="RenoLink"><a href="exception_destructor.html">~exception</a></span>();</pre>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
</div><h4>Effects:</h4>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
<p>Frees all resources associated with a boost::<span class="RenoLink"><a href="exception.html">exception</a></span> object.</p>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
<h4>Throws:</h4>
<p>Nothing.</p>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
</div><div class="RenoIncludeDIV"><h3>exception::diagnostic_information</h3>
<div class="RenoIncludeDIV"><pre>virtual char const * <span class="RenoLink"><a href="exception_diagnostic_information.html">diagnostic_information</a></span>() const throw();</pre>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
</div><h4>Returns:</h4>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
<p>An string representation of all data stored in the boost::<span class="RenoLink"><a href="exception.html">exception</a></span> object by the <span class="RenoLink"><a href="operator_shl_exception.html">operator&lt;&lt;</a></span> function. See "<span class="RenoLink"><a href="tutorial_diagnostic_information.html">Tutorial: Diagnostic Information</a></span>" for details.</p>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
<h4>Throws:</h4>
<p>Nothing.</p>
<h4>Note:</h4>
<p>The return value remains valid until the exception object from which it is obtained is destroyed or modified.</p>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
</div><div class="RenoIncludeDIV"><h3>exception::what</h3>
<div class="RenoIncludeDIV"><pre>virtual char const * <span class="RenoLink"><a href="exception_what.html">what</a></span>() const throw();</pre>
</div><h4>Returns:</h4>
<p>The default implementation is equivalent to return <span class="RenoLink"><a href="exception_diagnostic_information.html">exception::diagnostic_information</a></span>(). The signature of boost::<span class="RenoLink"><a href="exception_what.html">exception::what</a></span> is identical to the familiar std::exception::what function, so that when an exception type that derives both std::exception and boost::<span class="RenoLink"><a href="exception.html">exception</a></span> overrides the what function, it overrides both std::exception::what and boost::<span class="RenoLink"><a href="exception_what.html">exception::what</a></span>.</p>
<h4>Throws:</h4>
<p>Nothing.</p>
<h4>Note:</h4>
<p>The return value remains valid until the exception object from which it is obtained is destroyed or modified.</p>
</div></div><h3>See also:</h3>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
<div class="RenoPageList"><a href="BOOST_ERROR_INFO.html">BOOST_ERROR_INFO<br/>
</a><a href="boost-exception.html">Boost Exception<br/>
Boost Exception documentation update [SVN r44444]
2008-04-15 21:56:34 +00:00
</a><a href="current_exception.html">current_exception<br/>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
</a><a href="diagnostic_information.html">diagnostic_information<br/>
Boost Exception documentation update [SVN r44444]
2008-04-15 21:56:34 +00:00
</a><a href="enable_current_exception.html">enable_current_exception<br/>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
</a><a href="enable_error_info.html">enable_error_info<br/>
</a><a href="error_info.html">error_info<br/>
</a><a href="get_error_info.html">get_error_info<br/>
</a><a href="operator_shl_exception.html">operator&lt;&lt;/exception<br/>
documentation update, added function exception::diagnostic_information, added std::exception to_string overload, removed tabs from source files [SVN r46697]
2008-06-25 23:27:56 +00:00
</a><a href="operator_shl_tuple.html">operator&lt;&lt;/tuple<br/>
</a><a href="tutorial_diagnostic_information.html">Tutorial: Diagnostic Information<br/>
</a><a href="tutorial_enable_error_info.html">Tutorial: Integrating Boost Exception in Existing Exception Class Hierarchies<br/>
</a><a href="tutorial_transporting_data.html">Tutorial: Transporting of Arbitrary Data to the Catch Site<br/>
</a><a href="tutorial_exception_ptr.html">Tutorial: Transporting of Exceptions between Threads<br/>
</a><a href="unknown_exception.html">unknown_exception<br/>
boost exception [SVN r43485]
2008-03-04 01:41:17 +00:00
</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 [SVN r43485]
2008-03-04 01:41:17 +00:00
<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>
Reference in New Issue Copy Permalink