DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
libctru/errf_8h.html
WinterMute e52f3175e1 Deploying to gh-pages from @ 8cbcce773b 🚀
2024-11-03 20:36:34 +00:00

434 lines
28 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libctru: include/3ds/errf.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libctru
&#160;<span id="projectnumber">v2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">errf.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Error Display API.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="types_8h_source.html">3ds/types.h</a>&gt;</code><br />
</div>
<p><a href="errf_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structERRF__ExceptionInfo.html">ERRF_ExceptionInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structERRF__ExceptionData.html">ERRF_ExceptionData</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structERRF__FatalErrInfo.html">ERRF_FatalErrInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a61a0c7d3c30f1082f5ca26644873e9f1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1">ERRF_ErrType</a> { <br />
&#160;&#160;<a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a974d51ce630cc09441279ab080d0e666">ERRF_ERRTYPE_GENERIC</a> = 0
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1ab0243f356f22723f6a5d1ff01eff05af">ERRF_ERRTYPE_NAND_DAMAGED</a> = 1
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a4dd431336e8dc4a819f97ace6b5c8e39">ERRF_ERRTYPE_CARD_REMOVED</a> = 2
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a5f67936389cd0f9d0bf7d9d4060f5dcc">ERRF_ERRTYPE_EXCEPTION</a> = 3
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1ae455818133dfc035f27bc0039496161e">ERRF_ERRTYPE_FAILURE</a> = 4
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a45e0f0ed85c5b226806ceb98548fd5f1">ERRF_ERRTYPE_LOG_ONLY</a> = 5
<br />
}</td></tr>
<tr class="memdesc:a61a0c7d3c30f1082f5ca26644873e9f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Types of errors that can be thrown by err:f. <a href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1">More...</a><br /></td></tr>
<tr class="separator:a61a0c7d3c30f1082f5ca26644873e9f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b4fd015c0f15a8c060a4dcd4d385fb4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a8b4fd015c0f15a8c060a4dcd4d385fb4">ERRF_ExceptionType</a> { <br />
&#160;&#160;<a class="el" href="errf_8h.html#a8b4fd015c0f15a8c060a4dcd4d385fb4a22fd747926a2427e836ca01c0f08749f">ERRF_EXCEPTION_PREFETCH_ABORT</a> = 0
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a8b4fd015c0f15a8c060a4dcd4d385fb4ac3fcf2185c54992445e425ca124364ba">ERRF_EXCEPTION_DATA_ABORT</a> = 1
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a8b4fd015c0f15a8c060a4dcd4d385fb4a0dc50b554bd87bac9e332a354d534426">ERRF_EXCEPTION_UNDEFINED</a> = 2
, <br />
&#160;&#160;<a class="el" href="errf_8h.html#a8b4fd015c0f15a8c060a4dcd4d385fb4ada008b276032c006a4963a0c21c79762">ERRF_EXCEPTION_VFP</a> = 3
<br />
}</td></tr>
<tr class="memdesc:a8b4fd015c0f15a8c060a4dcd4d385fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Types of 'Exceptions' thrown for ERRF_ERRTYPE_EXCEPTION. <a href="errf_8h.html#a8b4fd015c0f15a8c060a4dcd4d385fb4">More...</a><br /></td></tr>
<tr class="separator:a8b4fd015c0f15a8c060a4dcd4d385fb4"><td class="memSeparator" colspan="2">&#160;</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:ac01f0bf7d1f4b093304d02b07ce041b7"><td class="memItemLeft" align="right" valign="top"><a id="ac01f0bf7d1f4b093304d02b07ce041b7"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#ac01f0bf7d1f4b093304d02b07ce041b7">errfInit</a> (void)</td></tr>
<tr class="memdesc:ac01f0bf7d1f4b093304d02b07ce041b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this. <br /></td></tr>
<tr class="separator:ac01f0bf7d1f4b093304d02b07ce041b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a629fbb8eb87ccd50fe8bc19b41efc754"><td class="memItemLeft" align="right" valign="top"><a id="a629fbb8eb87ccd50fe8bc19b41efc754"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a629fbb8eb87ccd50fe8bc19b41efc754">errfExit</a> (void)</td></tr>
<tr class="memdesc:a629fbb8eb87ccd50fe8bc19b41efc754"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits ERR:f. Unless you plan to call ERRF_Throw yourself, do not use this. <br /></td></tr>
<tr class="separator:a629fbb8eb87ccd50fe8bc19b41efc754"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ae083ea6b3ce9070c6a3bde3b38d372"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a8ae083ea6b3ce9070c6a3bde3b38d372">errfGetSessionHandle</a> (void)</td></tr>
<tr class="memdesc:a8ae083ea6b3ce9070c6a3bde3b38d372"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current err:f API session handle. <a href="errf_8h.html#a8ae083ea6b3ce9070c6a3bde3b38d372">More...</a><br /></td></tr>
<tr class="separator:a8ae083ea6b3ce9070c6a3bde3b38d372"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99561fca39e236490227ea10586d5600"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a99561fca39e236490227ea10586d5600">ERRF_Throw</a> (const <a class="el" href="structERRF__FatalErrInfo.html">ERRF_FatalErrInfo</a> *error)</td></tr>
<tr class="memdesc:a99561fca39e236490227ea10586d5600"><td class="mdescLeft">&#160;</td><td class="mdescRight">Throws a system error and possibly logs it. <a href="errf_8h.html#a99561fca39e236490227ea10586d5600">More...</a><br /></td></tr>
<tr class="separator:a99561fca39e236490227ea10586d5600"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0320c231112031c907d55d41a646b35b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a0320c231112031c907d55d41a646b35b">ERRF_ThrowResult</a> (<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> failure)</td></tr>
<tr class="memdesc:a0320c231112031c907d55d41a646b35b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Throws (and logs) a system error with the given Result code. <a href="errf_8h.html#a0320c231112031c907d55d41a646b35b">More...</a><br /></td></tr>
<tr class="separator:a0320c231112031c907d55d41a646b35b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83184c59d3020fc20e9e6a87706396c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a83184c59d3020fc20e9e6a87706396c3">ERRF_LogResult</a> (<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> failure)</td></tr>
<tr class="memdesc:a83184c59d3020fc20e9e6a87706396c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logs a system error with the given Result code. <a href="errf_8h.html#a83184c59d3020fc20e9e6a87706396c3">More...</a><br /></td></tr>
<tr class="separator:a83184c59d3020fc20e9e6a87706396c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b8dd75d6d8caca5ca1ed957455b47c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a7b8dd75d6d8caca5ca1ed957455b47c3">ERRF_ThrowResultWithMessage</a> (<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> failure, const char *message)</td></tr>
<tr class="memdesc:a7b8dd75d6d8caca5ca1ed957455b47c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Throws a system error with the given Result code and message. <a href="errf_8h.html#a7b8dd75d6d8caca5ca1ed957455b47c3">More...</a><br /></td></tr>
<tr class="separator:a7b8dd75d6d8caca5ca1ed957455b47c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a329c838447123a5ecbfdabbd5c13f1f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a329c838447123a5ecbfdabbd5c13f1f7">ERRF_SetUserString</a> (const char *user_string)</td></tr>
<tr class="memdesc:a329c838447123a5ecbfdabbd5c13f1f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify an additional user string to use for error reporting. <a href="errf_8h.html#a329c838447123a5ecbfdabbd5c13f1f7">More...</a><br /></td></tr>
<tr class="separator:a329c838447123a5ecbfdabbd5c13f1f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4265599a9b0dcfb716879ae9bd2a0923"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="errf_8h.html#a4265599a9b0dcfb716879ae9bd2a0923">ERRF_ExceptionHandler</a> (<a class="el" href="structERRF__ExceptionInfo.html">ERRF_ExceptionInfo</a> *excep, <a class="el" href="structCpuRegisters.html">CpuRegisters</a> *regs) <a class="el" href="rbtree_8h.html#a797a3e1c8507a7c7b4e051d3f1349154">__attribute__</a>((noreturn))</td></tr>
<tr class="memdesc:a4265599a9b0dcfb716879ae9bd2a0923"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles an exception using ErrDisp. <a href="errf_8h.html#a4265599a9b0dcfb716879ae9bd2a0923">More...</a><br /></td></tr>
<tr class="separator:a4265599a9b0dcfb716879ae9bd2a0923"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Error Display API. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a61a0c7d3c30f1082f5ca26644873e9f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61a0c7d3c30f1082f5ca26644873e9f1">&#9670;&nbsp;</a></span>ERRF_ErrType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1">ERRF_ErrType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Types of errors that can be thrown by err:f. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a61a0c7d3c30f1082f5ca26644873e9f1a974d51ce630cc09441279ab080d0e666"></a>ERRF_ERRTYPE_GENERIC&#160;</td><td class="fielddoc"><p>Generic fatal error. Shows miscellaneous info, including the address of the caller. </p>
</td></tr>
<tr><td class="fieldname"><a id="a61a0c7d3c30f1082f5ca26644873e9f1ab0243f356f22723f6a5d1ff01eff05af"></a>ERRF_ERRTYPE_NAND_DAMAGED&#160;</td><td class="fielddoc"><p>Damaged NAND (CC_ERROR after reading CSR) </p>
</td></tr>
<tr><td class="fieldname"><a id="a61a0c7d3c30f1082f5ca26644873e9f1a4dd431336e8dc4a819f97ace6b5c8e39"></a>ERRF_ERRTYPE_CARD_REMOVED&#160;</td><td class="fielddoc"><p>Game content storage medium (cartridge and/or SD card) ejected. Not logged. </p>
</td></tr>
<tr><td class="fieldname"><a id="a61a0c7d3c30f1082f5ca26644873e9f1a5f67936389cd0f9d0bf7d9d4060f5dcc"></a>ERRF_ERRTYPE_EXCEPTION&#160;</td><td class="fielddoc"><p>CPU or VFP exception. </p>
</td></tr>
<tr><td class="fieldname"><a id="a61a0c7d3c30f1082f5ca26644873e9f1ae455818133dfc035f27bc0039496161e"></a>ERRF_ERRTYPE_FAILURE&#160;</td><td class="fielddoc"><p>Fatal error with a message instead of the caller's address. </p>
</td></tr>
<tr><td class="fieldname"><a id="a61a0c7d3c30f1082f5ca26644873e9f1a45e0f0ed85c5b226806ceb98548fd5f1"></a>ERRF_ERRTYPE_LOG_ONLY&#160;</td><td class="fielddoc"><p>Log-level failure. Does not display the exception and does not force the system to reboot. </p>
</td></tr>
</table>
</div>
</div>
<a id="a8b4fd015c0f15a8c060a4dcd4d385fb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b4fd015c0f15a8c060a4dcd4d385fb4">&#9670;&nbsp;</a></span>ERRF_ExceptionType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="errf_8h.html#a8b4fd015c0f15a8c060a4dcd4d385fb4">ERRF_ExceptionType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Types of 'Exceptions' thrown for ERRF_ERRTYPE_EXCEPTION. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8b4fd015c0f15a8c060a4dcd4d385fb4a22fd747926a2427e836ca01c0f08749f"></a>ERRF_EXCEPTION_PREFETCH_ABORT&#160;</td><td class="fielddoc"><p>Prefetch Abort. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8b4fd015c0f15a8c060a4dcd4d385fb4ac3fcf2185c54992445e425ca124364ba"></a>ERRF_EXCEPTION_DATA_ABORT&#160;</td><td class="fielddoc"><p>Data abort. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8b4fd015c0f15a8c060a4dcd4d385fb4a0dc50b554bd87bac9e332a354d534426"></a>ERRF_EXCEPTION_UNDEFINED&#160;</td><td class="fielddoc"><p>Undefined instruction. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8b4fd015c0f15a8c060a4dcd4d385fb4ada008b276032c006a4963a0c21c79762"></a>ERRF_EXCEPTION_VFP&#160;</td><td class="fielddoc"><p>VFP (floating point) exception. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4265599a9b0dcfb716879ae9bd2a0923"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4265599a9b0dcfb716879ae9bd2a0923">&#9670;&nbsp;</a></span>ERRF_ExceptionHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ERRF_ExceptionHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structERRF__ExceptionInfo.html">ERRF_ExceptionInfo</a> *&#160;</td>
<td class="paramname"><em>excep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structCpuRegisters.html">CpuRegisters</a> *&#160;</td>
<td class="paramname"><em>regs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handles an exception using ErrDisp. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">excep</td><td>Exception information </td></tr>
<tr><td class="paramname">regs</td><td>CPU registers</td></tr>
</table>
</dd>
</dl>
<p>You might want to clear ENVINFO's bit0 to be able to see any debugging information. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="thread_8h.html#ad102ce4415b0054ec6903a5668e5ffab" title="Sets the exception handler for the current thread.">threadOnException</a> </dd></dl>
</div>
</div>
<a id="a83184c59d3020fc20e9e6a87706396c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83184c59d3020fc20e9e6a87706396c3">&#9670;&nbsp;</a></span>ERRF_LogResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> ERRF_LogResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td>
<td class="paramname"><em>failure</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a system error with the given Result code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">failure</td><td>Result code to log.</td></tr>
</table>
</dd>
</dl>
<p>Similar to <a class="el" href="errf_8h.html#a99561fca39e236490227ea10586d5600">ERRF_Throw</a>, except that it does not display anything on the screen, nor does it force the system to reboot.</p>
<p>This function <em>does</em> fill in the address where this function was called from. </p>
</div>
</div>
<a id="a329c838447123a5ecbfdabbd5c13f1f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a329c838447123a5ecbfdabbd5c13f1f7">&#9670;&nbsp;</a></span>ERRF_SetUserString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> ERRF_SetUserString </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>user_string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify an additional user string to use for error reporting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">user_string</td><td>User string (up to 256 bytes, not including NUL byte) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a99561fca39e236490227ea10586d5600"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99561fca39e236490227ea10586d5600">&#9670;&nbsp;</a></span>ERRF_Throw()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> ERRF_Throw </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structERRF__FatalErrInfo.html">ERRF_FatalErrInfo</a> *&#160;</td>
<td class="paramname"><em>error</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Throws a system error and possibly logs it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Error to throw.</td></tr>
</table>
</dd>
</dl>
<p>ErrDisp may convert the error info to <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1ab0243f356f22723f6a5d1ff01eff05af">ERRF_ERRTYPE_NAND_DAMAGED</a> or <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a4dd431336e8dc4a819f97ace6b5c8e39">ERRF_ERRTYPE_CARD_REMOVED</a> depending on the error code.</p>
<p>Except with <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a45e0f0ed85c5b226806ceb98548fd5f1">ERRF_ERRTYPE_LOG_ONLY</a>, the system will panic and will need to be rebooted. Fatal error information will also be logged into a file, unless the type either <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1ab0243f356f22723f6a5d1ff01eff05af">ERRF_ERRTYPE_NAND_DAMAGED</a> or <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a4dd431336e8dc4a819f97ace6b5c8e39">ERRF_ERRTYPE_CARD_REMOVED</a>.</p>
<p>No error will be shown if the system is asleep.</p>
<p>On retail units with vanilla firmware, no detailed information will be displayed on screen.</p>
<p>You may wish to use <a class="el" href="errf_8h.html#a0320c231112031c907d55d41a646b35b" title="Throws (and logs) a system error with the given Result code.">ERRF_ThrowResult()</a> or <a class="el" href="errf_8h.html#a7b8dd75d6d8caca5ca1ed957455b47c3" title="Throws a system error with the given Result code and message.">ERRF_ThrowResultWithMessage()</a> instead of constructing the <a class="el" href="structERRF__FatalErrInfo.html">ERRF_FatalErrInfo</a> struct yourself. </p>
</div>
</div>
<a id="a0320c231112031c907d55d41a646b35b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0320c231112031c907d55d41a646b35b">&#9670;&nbsp;</a></span>ERRF_ThrowResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> ERRF_ThrowResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td>
<td class="paramname"><em>failure</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Throws (and logs) a system error with the given Result code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">failure</td><td>Result code to throw.</td></tr>
</table>
</dd>
</dl>
<p>This calls <a class="el" href="errf_8h.html#a99561fca39e236490227ea10586d5600">ERRF_Throw</a> with error type <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1a974d51ce630cc09441279ab080d0e666">ERRF_ERRTYPE_GENERIC</a> and fills in the required data.</p>
<p>This function <em>does</em> fill in the address where this function was called from. </p>
</div>
</div>
<a id="a7b8dd75d6d8caca5ca1ed957455b47c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b8dd75d6d8caca5ca1ed957455b47c3">&#9670;&nbsp;</a></span>ERRF_ThrowResultWithMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> ERRF_ThrowResultWithMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td>
<td class="paramname"><em>failure</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>message</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Throws a system error with the given Result code and message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">failure</td><td>Result code to throw. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>The message to display.</td></tr>
</table>
</dd>
</dl>
<p>This calls <a class="el" href="errf_8h.html#a99561fca39e236490227ea10586d5600">ERRF_Throw</a> with error type <a class="el" href="errf_8h.html#a61a0c7d3c30f1082f5ca26644873e9f1ae455818133dfc035f27bc0039496161e">ERRF_ERRTYPE_FAILURE</a> and fills in the required data.</p>
<p>This function does <em>not</em> fill in the address where this function was called from because it would not be displayed. </p>
</div>
</div>
<a id="a8ae083ea6b3ce9070c6a3bde3b38d372"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ae083ea6b3ce9070c6a3bde3b38d372">&#9670;&nbsp;</a></span>errfGetSessionHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* errfGetSessionHandle </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current err:f API session handle. </p>
<dl class="section return"><dt>Returns</dt><dd>The current err:f API session handle. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink