2009-09-29 20:38:11 +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_what</ 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 = "../../../boost.png" alt = "Boost" width = "277" height = "86" /></ a >
</ div >
< h1 > Boost Exception</ h1 >
</ div >
<!-- Copyright (c) 2006-2009 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" >< div class = "RenoAutoDIV" >< h3 > diagnostic_information_what</ h3 >
</ div >
< 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 >
< pre > namespace
boost
{
2013-03-08 02:01:44 +00:00
< 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 >
2009-09-29 20:38:11 +00:00
}</ pre >
</ 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 >
< h4 > Returns:</ h4 >
< 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 >
< h4 > Throws:</ h4 >
< p > Nothing.</ p >
< h4 > Note:</ h4 >
< 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 >
</ div >< div class = "RenoAutoDIV" >< div class = "RenoHR" >< hr /></ div >
2009-10-22 07:14:09 +00:00
See also: < span class = "RenoPageList" >< a href = "boost_exception_diagnostic_information_hpp.html" > boost/exception/diagnostic_information.hpp</ a ></ span >
2009-09-29 20:38:11 +00:00
</ div >
<!-- Copyright (c) 2006-2009 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 >
< 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 >
< 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-2009 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 >
