libnx/fatal_8h.html
2025-05-08 06:59:12 +00:00

271 lines
15 KiB
HTML

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/services/fatal.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</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">fatal.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Fatal error (fatal:u) service IPC wrapper.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
</div>
<p><a href="fatal_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 id="nested-classes" 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="structFatalAarch64Context.html">FatalAarch64Context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct for fatal Cpu context, 64-bit. <a href="structFatalAarch64Context.html#details">More...</a><br /></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="structFatalAarch32Context.html">FatalAarch32Context</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct for fatal Cpu context, 32-bit. <a href="structFatalAarch32Context.html#details">More...</a><br /></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="structFatalCpuContext.html">FatalCpuContext</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 id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a8d822b2a062eacbe6569675592fa72fe" id="r_a8d822b2a062eacbe6569675592fa72fe"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a> { <br />
&#160;&#160;<b>FatalPolicy_ErrorReportAndErrorScreen</b> = 0
, <br />
&#160;&#160;<b>FatalPolicy_ErrorReport</b> = 1
, <br />
&#160;&#160;<a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72feafb9ff0baa56c117e14a7efa52613f676">FatalPolicy_ErrorScreen</a> = 2
<br />
}</td></tr>
<tr class="memdesc:a8d822b2a062eacbe6569675592fa72fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of thrown fatal error. <a href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">More...</a><br /></td></tr>
<tr class="separator:a8d822b2a062eacbe6569675592fa72fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a43d428e5aa6903a4476e43fcb1426531" id="r_a43d428e5aa6903a4476e43fcb1426531"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fatal_8h.html#a43d428e5aa6903a4476e43fcb1426531">fatalThrow</a> (<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> err)</td></tr>
<tr class="memdesc:a43d428e5aa6903a4476e43fcb1426531"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triggers a system fatal error. <br /></td></tr>
<tr class="separator:a43d428e5aa6903a4476e43fcb1426531"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae188d5edeeccec67976bca7e5c25ffc2" id="r_ae188d5edeeccec67976bca7e5c25ffc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fatal_8h.html#ae188d5edeeccec67976bca7e5c25ffc2">fatalThrowWithPolicy</a> (<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> err, <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a> type)</td></tr>
<tr class="memdesc:ae188d5edeeccec67976bca7e5c25ffc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triggers a system fatal error with a custom <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a>. <br /></td></tr>
<tr class="separator:ae188d5edeeccec67976bca7e5c25ffc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9e9bfc923c0bf8415ed200eac48bd01" id="r_ae9e9bfc923c0bf8415ed200eac48bd01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fatal_8h.html#ae9e9bfc923c0bf8415ed200eac48bd01">fatalThrowWithContext</a> (<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> err, <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a> type, <a class="el" href="structFatalCpuContext.html">FatalCpuContext</a> *ctx)</td></tr>
<tr class="memdesc:ae9e9bfc923c0bf8415ed200eac48bd01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triggers a system fatal error with a custom <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a> and <a class="el" href="structFatalCpuContext.html">FatalCpuContext</a>. <br /></td></tr>
<tr class="separator:ae9e9bfc923c0bf8415ed200eac48bd01"><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>Fatal error (fatal:u) service IPC wrapper. </p>
<dl class="section author"><dt>Author</dt><dd>plutoo </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a8d822b2a062eacbe6569675592fa72fe" name="a8d822b2a062eacbe6569675592fa72fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d822b2a062eacbe6569675592fa72fe">&#9670;&#160;</a></span>FatalPolicy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of thrown fatal error. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8d822b2a062eacbe6569675592fa72feafb9ff0baa56c117e14a7efa52613f676" name="a8d822b2a062eacbe6569675592fa72feafb9ff0baa56c117e14a7efa52613f676"></a>FatalPolicy_ErrorScreen&#160;</td><td class="fielddoc"><p>Only available with [3.0.0+]. If specified, FatalPolicy_ErrorReportAndErrorScreen will be used instead on pre-3.0.0. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a43d428e5aa6903a4476e43fcb1426531" name="a43d428e5aa6903a4476e43fcb1426531"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43d428e5aa6903a4476e43fcb1426531">&#9670;&#160;</a></span>fatalThrow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fatalThrow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Triggers a system fatal error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err</td><td>Result code to throw. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function does not return. </dd>
<dd>
This uses <a class="el" href="fatal_8h.html#ae188d5edeeccec67976bca7e5c25ffc2">fatalThrowWithPolicy</a> with <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72feafb9ff0baa56c117e14a7efa52613f676">FatalPolicy_ErrorScreen</a> internally. </dd></dl>
</div>
</div>
<a id="ae9e9bfc923c0bf8415ed200eac48bd01" name="ae9e9bfc923c0bf8415ed200eac48bd01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9e9bfc923c0bf8415ed200eac48bd01">&#9670;&#160;</a></span>fatalThrowWithContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fatalThrowWithContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFatalCpuContext.html">FatalCpuContext</a> *&#160;</td>
<td class="paramname"><em>ctx</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Triggers a system fatal error with a custom <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a> and <a class="el" href="structFatalCpuContext.html">FatalCpuContext</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err</td><td>Result code to throw. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of fatal error to throw. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>Cpu context for fatal error to throw. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function may not return, depending on <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a>. </dd></dl>
</div>
</div>
<a id="ae188d5edeeccec67976bca7e5c25ffc2" name="ae188d5edeeccec67976bca7e5c25ffc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae188d5edeeccec67976bca7e5c25ffc2">&#9670;&#160;</a></span>fatalThrowWithPolicy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fatalThrowWithPolicy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a>&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Triggers a system fatal error with a custom <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err</td><td>Result code to throw. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of fatal error to throw. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function may not return, depending on <a class="el" href="fatal_8h.html#a8d822b2a062eacbe6569675592fa72fe">FatalPolicy</a>. </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.8
</small></address>
</body>
</html>