File: throw_exception.html

package info (click to toggle)
boost1.35 1.35.0-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 203,856 kB
  • ctags: 337,867
  • sloc: cpp: 938,683; xml: 56,847; ansic: 41,589; python: 18,999; sh: 11,566; makefile: 664; perl: 494; yacc: 456; asm: 353; csh: 6
file content (58 lines) | stat: -rw-r--r-- 2,124 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
	<head>
		<title>Boost: throw_exception.hpp documentation</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
	</head>
	<body bgcolor="white" style="MARGIN-LEFT: 5%; MARGIN-RIGHT: 5%">
		<table border="0" width="100%">
			<tr>
				<td width="277"><A href="../../index.htm"> <img src="../../boost.png" alt="boost.png (6897 bytes)" width="277" height="86" border="0"></A>
				</td>
				<td align="center">
					<h1>throw_exception.hpp</h1>
				</td>
			</tr>
			<tr>
				<td colspan="2" height="64">&nbsp;</td>
			</tr>
		</table>
		<p>
			The header <STRONG>&lt;boost/throw_exception.hpp&gt;</STRONG> defines the 
			helper function <STRONG>boost::throw_exception</STRONG>. It is intended to be 
			used in Boost libraries that need to throw exceptions, but support 
			configurations and platforms where exceptions aren't available, as indicated by 
			the presence of the <STRONG>BOOST_NO_EXCEPTIONS</STRONG> <A href="../config/config.htm#macro_ref">
				configuration macro</A>.
		</p>
		<P>When <STRONG>BOOST_NO_EXCEPTIONS</STRONG> is not defined, <tt>boost::throw_exception(e)</tt>
			is equivalent to <tt>throw e</tt>. Otherwise, the function is left undefined, 
			and the user is expected to supply an appropriate definition. Callers of <tt>throw_exception</tt>
			are allowed to assume that the function never returns; therefore, if the 
			user-defined <tt>throw_exception</tt> returns, the behavior is undefined.</P>
		<h3><a name="Synopsis">Synopsis</a></h3>
		<pre>
namespace boost
{

#ifdef BOOST_NO_EXCEPTIONS

void throw_exception(std::exception const &amp; e); // user defined

#else

template&lt;class E&gt; void throw_exception(E const &amp; e)
{
    throw e;
}

#endif

}
</pre>
		<p><br>
			<small>Copyright  2002 by Peter Dimov. Distributed under the Boost Software License, Version 
				1.0. See accompanying file <A href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or 
				copy at <A href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>.</small></p>
	</body>
</html>