feedc0de/boost_exception
1
0
Fork 0
forked from boostorg/exception
Code Pull Requests Activity
Files
c9d1d02ec352826062ae0ea587d7fe45883213f2
boost_exception/doc/diagnostic_information.html

89 lines
6.3 KiB
HTML
Raw Normal View History

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
<!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>diagnostic_information</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>
documentation copyright message update [SVN r52125]
2009-04-02 05:00:47 +00:00
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->
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
<!-- 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) -->
removed tabs from source files updated documentation [SVN r47250]
2008-07-09 00:18:09 +00:00
<div class="RenoIncludeDIV"><div class="RenoAutoDIV"><h3>diagnostic_information</h3>
</div>
documentation update [SVN r48619]
2008-09-05 18:24:54 +00:00
<div class="RenoIncludeDIV"><p><span class="RenoEscape">&#35;<!--<wiki>`&#35;</wiki>--></span>include &lt;<span class="RenoLink"><a href="exception_diagnostic_information_hpp.html">boost/exception/diagnostic_information.hpp</a></span>&gt;<span class="RenoBR">&nbsp;</span><br/></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
<pre>namespace
boost
{
get_error_info returns raw pointer instead of shared_ptr (breaking change) diagnostic_information can now be called with boost::exception or std::exception object. BOOST_THROW_EXCEPTION can now be used even if exceptions are disabled. added functions: current_exception_diagnostic_information, current_exception_cast documentation updated to match. [SVN r52225]
2009-04-06 23:15:42 +00:00
<span class="RenoIncludeSPAN"> template &lt;class E&gt;
Documentation update [SVN r52265]
2009-04-08 20:08:44 +00:00
std::string <span class="RenoLink">diagnostic_information</span>( E const &amp; e );</span>
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
}</pre>
boost exception documentation update [SVN r48471]
2008-08-30 06:13:10 +00:00
</div><h4>Returns:</h4>
get_error_info returns raw pointer instead of shared_ptr (breaking change) diagnostic_information can now be called with boost::exception or std::exception object. BOOST_THROW_EXCEPTION can now be used even if exceptions are disabled. added functions: current_exception_diagnostic_information, current_exception_cast documentation updated to match. [SVN r52225]
2009-04-06 23:15:42 +00:00
<p>A string value that contains varying amount of implementation-specific diagnostic information about the passed exception object:</p>
<div><ul><li>If E can be statically converted to boost::<span class="RenoLink"><a href="exception.html">exception</a></span>, the returned value contains the string representations of all <span class="RenoLink"><a href="error_info.html">error_info</a></span> objects stored in the boost::<span class="RenoLink"><a href="exception.html">exception</a></span> through <span class="RenoLink"><a href="exception_operator_shl.html">operator&lt;&lt;</a></span>, along with other diagnostic information relevant to the exception. If e can be dynamically converted to std::exception, the returned value also contains the what() string.</li>
<li>Otherwise, if E can be statically converted std::exception:<div><ul><li>if e can be dynamically converted to boost::exception, the returned value is the same as if E could be statically converted to boost::<span class="RenoLink"><a href="exception.html">exception</a></span>;</li>
<li>otherwise the returned value contains the what() string.</li>
</ul></div>
</li>
Documentation update [SVN r52265]
2009-04-08 20:08:44 +00:00
<li>Otherwise, the boost::<span class="RenoLink">diagnostic_information</span> template is not available.</li>
get_error_info returns raw pointer instead of shared_ptr (breaking change) diagnostic_information can now be called with boost::exception or std::exception object. BOOST_THROW_EXCEPTION can now be used even if exceptions are disabled. added functions: current_exception_diagnostic_information, current_exception_cast documentation updated to match. [SVN r52225]
2009-04-06 23:15:42 +00:00
</ul></div>
documentation update [SVN r50508]
2009-01-08 01:31:33 +00:00
<p>The string representation of each <span class="RenoLink"><a href="error_info.html">error_info</a></span> object is deduced by a function call that is bound at the time the <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;Tag,T&gt; template is instantiated. The following overload resolutions are attempted in order:</p>
<div><ol><li>Unqualified call to to_string(x), where x is of type <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;Tag,T&gt; (the return value is expected to be of type std::string.)</li>
<li>Unqualified call to to_string(x.<span class="RenoLink"><a href="error_info_value.html">value</a></span>()) (the return value is expected to be of type std::string.)</li>
<li>Unqualified call to s &lt;&lt; x.<span class="RenoLink"><a href="error_info_value.html">value</a></span>(), where s is a std::ostringstream.</li>
</ol></div>
Documentation update [SVN r52265]
2009-04-08 20:08:44 +00:00
<p>The first successfully bound function is used at the time <span class="RenoLink">diagnostic_information</span> is called; if all 3 overload resolutions are unsuccessful, the system is unable to convert the <span class="RenoLink"><a href="error_info.html">error_info</a></span> object to string, and <i>an unspecified stub string value is used without issuing a compile error.</i></p>
boost exception documentation update [SVN r48471]
2008-08-30 06:13:10 +00:00
<h4>Notes:</h4>
documentation update [SVN r48544]
2008-09-02 21:02:25 +00:00
<div><ul><li>The format of the returned string is unspecified.</li>
<li>The returned string is <i>not</i> user-friendly.</li>
<li>The returned string may include additional platform-specific diagnostic information.</li>
boost exception documentation update [SVN r48471]
2008-08-30 06:13:10 +00:00
</ul></div>
documentation update [SVN r50539]
2009-01-10 21:40:22 +00:00
<div class="RenoIncludeDIV"><h4>Example:</h4>
Documentation update [SVN r52265]
2009-04-08 20:08:44 +00:00
<p>this is a possible output from the <span class="RenoLink">diagnostic_information</span> function, as used in <i>libs/exception/example/example_io.cpp:</i></p>
get_error_info returns raw pointer instead of shared_ptr (breaking change) diagnostic_information can now be called with boost::exception or std::exception object. BOOST_THROW_EXCEPTION can now be used even if exceptions are disabled. added functions: current_exception_diagnostic_information, current_exception_cast documentation updated to match. [SVN r52225]
2009-04-06 23:15:42 +00:00
<pre>example_io.cpp(83): Throw in function class boost::shared_ptr&lt;struct _iobuf&gt; __cdecl my_fopen(const char *,const char *)
documentation update [SVN r50539]
2009-01-10 21:40:22 +00:00
Dynamic exception type: class boost::exception_detail::clone_impl&lt;class fopen_error&gt;
std::exception::what: example_io error
[struct tag_errno *] = 2, OS says "No such file or directory"
[struct tag_file_name *] = tmp1.txt
[struct tag_function *] = fopen
[struct tag_open_mode *] = rb</pre>
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
removed tabs from source files updated documentation [SVN r47250]
2008-07-09 00:18:09 +00:00
<h3>See Also:</h3>
documentation update [SVN r48544]
2008-09-02 21:02:25 +00:00
<div class="RenoPageList"><a href="BOOST_THROW_EXCEPTION.html">BOOST_THROW_EXCEPTION<br/>
</a><a href="boost-exception.html">Boost Exception<br/>
documentation update [SVN r48619]
2008-09-05 18:24:54 +00:00
</a><a href="exception_diagnostic_information_hpp.html">boost/exception/diagnostic_information.hpp<br/>
get_error_info returns raw pointer instead of shared_ptr (breaking change) diagnostic_information can now be called with boost::exception or std::exception object. BOOST_THROW_EXCEPTION can now be used even if exceptions are disabled. added functions: current_exception_diagnostic_information, current_exception_cast documentation updated to match. [SVN r52225]
2009-04-06 23:15:42 +00:00
</a><a href="current_exception_diagnostic_information.html">current_exception_diagnostic_information<br/>
documentation update [SVN r48544]
2008-09-02 21:02:25 +00:00
</a><a href="tutorial_diagnostic_information.html">Diagnostic Information<br/>
Documentation update [SVN r52122]
2009-04-01 21:31:03 +00:00
</a><a href="frequently_asked_questions.html">Frequently Asked Questions<br/>
</a><a href="motivation.html">Motivation<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></div>
removed tabs from source files updated documentation [SVN r47250]
2008-07-09 00:18:09 +00:00
</div>
documentation copyright message update [SVN r52125]
2009-04-02 05:00:47 +00:00
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->
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
<!-- 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>
documentation update [SVN r52046]
2009-03-29 04:58:33 +00:00
<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>
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 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>
documentation copyright message update [SVN r52125]
2009-04-02 05:00:47 +00:00
<small>Copyright (c) 2006-2009 by Emil Dotchevski and Reverge Studios, Inc.<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
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>
Copy Permalink