| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.11" name="generator"/> |
| <title>mxnet: include/mxnet/c_api_error.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellpadding="0" cellspacing="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| </div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#define-members">Macros</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">c_api_error.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <p>Error handling for C API. |
| <a href="#details">More...</a></p> |
| <p><a href="c__api__error_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespacemxnet"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr> |
| <tr class="memdesc:namespacemxnet"><td class="mdescLeft"> </td><td class="mdescRight">namespace of mxnet <br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:a959a98c071ffbeb325ef0cdea9ddc3e2"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="c__api__error_8h.html#a959a98c071ffbeb325ef0cdea9ddc3e2">MX_API_BEGIN</a>() try { on_enter_api(__FUNCTION__);</td></tr> |
| <tr class="memdesc:a959a98c071ffbeb325ef0cdea9ddc3e2"><td class="mdescLeft"> </td><td class="mdescRight">Macros to guard beginning and end section of all functions every function starts with API_BEGIN() and finishes with API_END() or API_END_HANDLE_ERROR() The finally clause contains procedure to cleanup states when an error happens. <a href="#a959a98c071ffbeb325ef0cdea9ddc3e2">More...</a><br/></td></tr> |
| <tr class="separator:a959a98c071ffbeb325ef0cdea9ddc3e2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a18ba3014a2d5200443d7fece1c5f709d"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="c__api__error_8h.html#a18ba3014a2d5200443d7fece1c5f709d">MX_API_END</a>() } catch(dmlc::Error &_except_) { on_exit_api(); return <a class="el" href="c__api__error_8h.html#a5b63effa1a051d315c26274a81d32768">MXAPIHandleException</a>(_except_); } on_exit_api(); return 0;</td></tr> |
| <tr class="separator:a18ba3014a2d5200443d7fece1c5f709d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb261882494eb12821e327f5561653a5"><td align="right" class="memItemLeft" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="c__api__error_8h.html#abb261882494eb12821e327f5561653a5">MX_API_END_HANDLE_ERROR</a>(Finalize) } catch(dmlc::Error &_except_) { Finalize; on_exit_api(); return <a class="el" href="c__api__error_8h.html#a5b63effa1a051d315c26274a81d32768">MXAPIHandleException</a>(_except_); } on_exit_api(); return 0;</td></tr> |
| <tr class="separator:abb261882494eb12821e327f5561653a5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a4421f44ae0ced14e4bb0f867e2071f24"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="c__api__error_8h.html#a4421f44ae0ced14e4bb0f867e2071f24">MXAPISetLastError</a> (const char *msg)</td></tr> |
| <tr class="memdesc:a4421f44ae0ced14e4bb0f867e2071f24"><td class="mdescLeft"> </td><td class="mdescRight">Set the last error message needed by C API. <a href="#a4421f44ae0ced14e4bb0f867e2071f24">More...</a><br/></td></tr> |
| <tr class="separator:a4421f44ae0ced14e4bb0f867e2071f24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b63effa1a051d315c26274a81d32768"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="c__api__error_8h.html#a5b63effa1a051d315c26274a81d32768">MXAPIHandleException</a> (const dmlc::Error &e)</td></tr> |
| <tr class="memdesc:a5b63effa1a051d315c26274a81d32768"><td class="mdescLeft"> </td><td class="mdescRight">handle exception throwed out <a href="#a5b63effa1a051d315c26274a81d32768">More...</a><br/></td></tr> |
| <tr class="separator:a5b63effa1a051d315c26274a81d32768"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96185db91240c6ff9409834aa2451aac"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a96185db91240c6ff9409834aa2451aac">mxnet::on_enter_api</a> (const char *function)</td></tr> |
| <tr class="separator:a96185db91240c6ff9409834aa2451aac"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a015b61168caa28b3f4effe4f106ac8f7"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a015b61168caa28b3f4effe4f106ac8f7">mxnet::on_exit_api</a> ()</td></tr> |
| <tr class="separator:a015b61168caa28b3f4effe4f106ac8f7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Error handling for C API. </p> |
| <p>Copyright (c) 2018 by Contributors </p> |
| </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| <a class="anchor" id="a959a98c071ffbeb325ef0cdea9ddc3e2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MX_API_BEGIN</td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> try { on_enter_api(__FUNCTION__);</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Macros to guard beginning and end section of all functions every function starts with API_BEGIN() and finishes with API_END() or API_END_HANDLE_ERROR() The finally clause contains procedure to cleanup states when an error happens. </p> |
| </div> |
| </div> |
| <a class="anchor" id="a18ba3014a2d5200443d7fece1c5f709d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MX_API_END</td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> } catch(dmlc::Error &_except_) { on_exit_api(); return <a class="el" href="c__api__error_8h.html#a5b63effa1a051d315c26274a81d32768">MXAPIHandleException</a>(_except_); } on_exit_api(); return 0;</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <a class="anchor" id="abb261882494eb12821e327f5561653a5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define MX_API_END_HANDLE_ERROR</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">Finalize</td><td>)</td> |
| <td> } catch(dmlc::Error &_except_) { Finalize; on_exit_api(); return <a class="el" href="c__api__error_8h.html#a5b63effa1a051d315c26274a81d32768">MXAPIHandleException</a>(_except_); } on_exit_api(); return 0;</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a5b63effa1a051d315c26274a81d32768"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int MXAPIHandleException </td> |
| <td>(</td> |
| <td class="paramtype">const dmlc::Error & </td> |
| <td class="paramname"><em>e</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>handle exception throwed out </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">e</td><td>the exception </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the return value of API after exception is handled </dd></dl> |
| </div> |
| </div> |
| <a class="anchor" id="a4421f44ae0ced14e4bb0f867e2071f24"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void MXAPISetLastError </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>msg</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Set the last error message needed by C API. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">msg</td><td>The error message to set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Sep 19 2019 12:37:33 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |