]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
2 | 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
3 | <html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'> | |
4 | <head> | |
5 | <meta http-equiv='Content-Type' content='text/html; charset=utf-8'/> | |
6 | <title>diagnostic_information_what</title> | |
7 | <link href='reno.css' type='text/css' rel='stylesheet'/> | |
8 | </head> | |
9 | <body> | |
10 | <div class="body-0"> | |
11 | <div class="body-1"> | |
12 | <div class="body-2"> | |
13 | <div> | |
14 | <div id="boost_logo"> | |
15 | <a href="http://www.boost.org"><img style="border:0" src="../../../boost.png" alt="Boost" width="277" height="86"/></a> | |
16 | </div> | |
17 | <h1>Boost Exception</h1> | |
18 | </div> | |
19 | <!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. --> | |
20 | <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying --> | |
21 | <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) --> | |
22 | <div class="RenoIncludeDIV"><div class="RenoAutoDIV"><h3>diagnostic_information_what</h3> | |
23 | </div> | |
24 | <div class="RenoIncludeDIV"><p><span class="RenoEscape">#<!--<wiki>`#</wiki>--></span>include <<span class="RenoLink"><a href="boost_exception_diagnostic_information_hpp.html">boost/exception/diagnostic_information.hpp</a></span>><span class="RenoBR"> </span><br/></p> | |
25 | <pre>namespace | |
26 | boost | |
27 | { | |
28 | <span class="RenoIncludeSPAN"> char const * <span class="RenoLink">diagnostic_information_what</span>( boost::<span class="RenoLink"><a href="exception.html">exception</a></span> const & e, bool verbose=true ) throw();</span> | |
29 | }</pre> | |
30 | </div><p>The <span class="RenoLink">diagnostic_information_what</span> function is intended to be called from a user-defined std::exception::what() override. This allows diagnostic information to be returned as the what() string.</p> | |
31 | <h4>Returns:</h4> | |
32 | <p>A pointer to a zero-terminated buffer that contains a string similar to the std::string returned by the <span class="RenoLink"><a href="diagnostic_information.html">diagnostic_information</a></span> function, or null to indicate a failure.</p> | |
33 | <h4>Throws:</h4> | |
34 | <p>Nothing.</p> | |
35 | <h4>Note:</h4> | |
36 | <p>The returned pointer becomes invalid if any <span class="RenoLink"><a href="error_info.html">error_info</a></span> is modified or added to the exception object, or if another diagnostic information function is called.</p> | |
37 | </div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div> | |
38 | See also: <span class="RenoPageList"><a href="boost_exception_diagnostic_information_hpp.html">boost/exception/diagnostic_information.hpp</a></span> | |
39 | </div> | |
40 | <!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. --> | |
41 | <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying --> | |
42 | <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) --> | |
43 | <div id="footer"> | |
44 | <p> | |
45 | <a class="logo" href="http://jigsaw.w3.org/css-validator/check/referer"><img class="logo_pic" src="valid-css.png" alt="Valid CSS" height="31" width="88"/></a> | |
46 | <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> | |
47 | <small>Copyright (c) 2006-2009 by Emil Dotchevski and Reverge Studios, Inc.<br/> | |
48 | Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small> | |
49 | </p> | |
50 | </div> | |
51 | </div> | |
52 | </div> | |
53 | </div> | |
54 | </body> | |
55 | </html> |