libctru/error_8h.html
2024-11-03 20:36:34 +00:00

376 lines
20 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">
<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/applets/error.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><li class="navelem"><a class="el" href="dir_1c7e2ffa4b11c2c27de6db7f8722520d.html">applets</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">error.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Error applet.
<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="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="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="structerrorConf.html">errorConf</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:a06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="error_8h.html#a06fc87d81c62e9abb8790b6e5713c55bafb9e7dbc738a2577514a8138ec422cc1">ERROR_LANGUAGE_FLAG</a> = 0x100
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba9dcc1643730efd181f38f6ec0601fd29">ERROR_WORD_WRAP_FLAG</a> = 0x200
<br />
}</td></tr>
<tr class="separator:a06fc87d81c62e9abb8790b6e5713c55b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0455f547a8d97c35c868b184e0c92ffd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffd">errorType</a> { <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffdaf92feceab1e86b1db3922220d4e26664">ERROR_CODE</a> = 0
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffdadedd4701f21fd3366217c2475b97def0">ERROR_TEXT</a>
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffda858b3c0206d6d0f5d3cda16042e1abd8">ERROR_EULA</a>
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffda147b3e04139b891cd7f909af63ba7505">ERROR_TYPE_EULA_FIRST_BOOT</a>
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffda0140e9a3dec9b05cb39cbb1a98414a66">ERROR_TYPE_EULA_DRAW_ONLY</a>
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffdab240bc96ed151585772beed748a48973">ERROR_TYPE_AGREE</a>
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffdad4c9df6942a9735204062e56acc4ab67">ERROR_CODE_LANGUAGE</a> = ERROR_CODE | ERROR_LANGUAGE_FLAG
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffdae1a094b404a29ac5e378ce171ceb58e4">ERROR_TEXT_LANGUAGE</a> = ERROR_TEXT | ERROR_LANGUAGE_FLAG
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffda062aae4599248eaa95d57de9ac2ee3e3">ERROR_EULA_LANGUAGE</a> = ERROR_EULA | ERROR_LANGUAGE_FLAG
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffda0862f205f0ca80f76b49a867eed6f086">ERROR_TEXT_WORD_WRAP</a> = ERROR_TEXT | ERROR_WORD_WRAP_FLAG
, <br />
&#160;&#160;<a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffdaac245e4db1720be42d78eefe9825d301">ERROR_TEXT_LANGUAGE_WORD_WRAP</a> = ERROR_TEXT | ERROR_LANGUAGE_FLAG | ERROR_WORD_WRAP_FLAG
<br />
}</td></tr>
<tr class="separator:a0455f547a8d97c35c868b184e0c92ffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb7a930b9ef7929596e2320803d7331f"><td class="memItemLeft" align="right" valign="top"><a id="afb7a930b9ef7929596e2320803d7331f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>errorScreenFlag</b> { <br />
&#160;&#160;<b>ERROR_NORMAL</b> = 0
, <br />
&#160;&#160;<b>ERROR_STEREO</b>
<br />
}</td></tr>
<tr class="separator:afb7a930b9ef7929596e2320803d7331f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bfd9984c1cfc6eb287d006eb065a5dc"><td class="memItemLeft" align="right" valign="top"><a id="a8bfd9984c1cfc6eb287d006eb065a5dc"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>errorReturnCode</b> { <br />
&#160;&#160;<b>ERROR_UNKNOWN</b> = -1
, <br />
&#160;&#160;<b>ERROR_NONE</b> = 0
, <br />
&#160;&#160;<b>ERROR_SUCCESS</b>
, <br />
&#160;&#160;<b>ERROR_NOT_SUPPORTED</b>
, <br />
&#160;&#160;<b>ERROR_HOME_BUTTON</b> = 10
, <br />
&#160;&#160;<b>ERROR_SOFTWARE_RESET</b>
, <br />
&#160;&#160;<b>ERROR_POWER_BUTTON</b>
<br />
}</td></tr>
<tr class="separator:a8bfd9984c1cfc6eb287d006eb065a5dc"><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:a1da3d9fb9929410c09ae3c250c804afb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a1da3d9fb9929410c09ae3c250c804afb">errorInit</a> (<a class="el" href="structerrorConf.html">errorConf</a> *err, <a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffd">errorType</a> type, <a class="el" href="cfgu_8h.html#ac27a9ea95e702ef4a43794b0ac950987">CFG_Language</a> lang)</td></tr>
<tr class="memdesc:a1da3d9fb9929410c09ae3c250c804afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init the error applet. <a href="error_8h.html#a1da3d9fb9929410c09ae3c250c804afb">More...</a><br /></td></tr>
<tr class="separator:a1da3d9fb9929410c09ae3c250c804afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b764f8c4030681ef11c995f2d97adc3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a6b764f8c4030681ef11c995f2d97adc3">errorCode</a> (<a class="el" href="structerrorConf.html">errorConf</a> *err, int error)</td></tr>
<tr class="memdesc:a6b764f8c4030681ef11c995f2d97adc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets error code to display. <a href="error_8h.html#a6b764f8c4030681ef11c995f2d97adc3">More...</a><br /></td></tr>
<tr class="separator:a6b764f8c4030681ef11c995f2d97adc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30a8a7222331915c0a10901fe8b74f0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a30a8a7222331915c0a10901fe8b74f0e">errorText</a> (<a class="el" href="structerrorConf.html">errorConf</a> *err, const char *text)</td></tr>
<tr class="memdesc:a30a8a7222331915c0a10901fe8b74f0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets error text to display. <a href="error_8h.html#a30a8a7222331915c0a10901fe8b74f0e">More...</a><br /></td></tr>
<tr class="separator:a30a8a7222331915c0a10901fe8b74f0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24660ba95ca3de3aaf9e505bd0f3491b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#a24660ba95ca3de3aaf9e505bd0f3491b">errorDisp</a> (<a class="el" href="structerrorConf.html">errorConf</a> *err)</td></tr>
<tr class="memdesc:a24660ba95ca3de3aaf9e505bd0f3491b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Displays the error applet. <a href="error_8h.html#a24660ba95ca3de3aaf9e505bd0f3491b">More...</a><br /></td></tr>
<tr class="separator:a24660ba95ca3de3aaf9e505bd0f3491b"><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 applet. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a06fc87d81c62e9abb8790b6e5713c55b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06fc87d81c62e9abb8790b6e5713c55b">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a06fc87d81c62e9abb8790b6e5713c55bafb9e7dbc738a2577514a8138ec422cc1"></a>ERROR_LANGUAGE_FLAG&#160;</td><td class="fielddoc"><p>??-Unknown flag </p>
</td></tr>
<tr><td class="fieldname"><a id="a06fc87d81c62e9abb8790b6e5713c55ba9dcc1643730efd181f38f6ec0601fd29"></a>ERROR_WORD_WRAP_FLAG&#160;</td><td class="fielddoc"><p>??-Unknown flag </p>
</td></tr>
</table>
</div>
</div>
<a id="a0455f547a8d97c35c868b184e0c92ffd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0455f547a8d97c35c868b184e0c92ffd">&#9670;&nbsp;</a></span>errorType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="error_8h.html#a0455f547a8d97c35c868b184e0c92ffd">errorType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffdaf92feceab1e86b1db3922220d4e26664"></a>ERROR_CODE&#160;</td><td class="fielddoc"><p>Displays the infrastructure communications-related error message corresponding to the error code. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffdadedd4701f21fd3366217c2475b97def0"></a>ERROR_TEXT&#160;</td><td class="fielddoc"><p>Displays text passed to this applet. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffda858b3c0206d6d0f5d3cda16042e1abd8"></a>ERROR_EULA&#160;</td><td class="fielddoc"><p>Displays the EULA. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffda147b3e04139b891cd7f909af63ba7505"></a>ERROR_TYPE_EULA_FIRST_BOOT&#160;</td><td class="fielddoc"><p>Use prohibited. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffda0140e9a3dec9b05cb39cbb1a98414a66"></a>ERROR_TYPE_EULA_DRAW_ONLY&#160;</td><td class="fielddoc"><p>Use prohibited. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffdab240bc96ed151585772beed748a48973"></a>ERROR_TYPE_AGREE&#160;</td><td class="fielddoc"><p>Use prohibited. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffdad4c9df6942a9735204062e56acc4ab67"></a>ERROR_CODE_LANGUAGE&#160;</td><td class="fielddoc"><p>Displays a network error message in a specified language. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffdae1a094b404a29ac5e378ce171ceb58e4"></a>ERROR_TEXT_LANGUAGE&#160;</td><td class="fielddoc"><p>Displays text passed to this applet in a specified language. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffda062aae4599248eaa95d57de9ac2ee3e3"></a>ERROR_EULA_LANGUAGE&#160;</td><td class="fielddoc"><p>Displays EULA in a specified language. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffda0862f205f0ca80f76b49a867eed6f086"></a>ERROR_TEXT_WORD_WRAP&#160;</td><td class="fielddoc"><p>Displays the custom error message passed to this applet with automatic line wrapping. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0455f547a8d97c35c868b184e0c92ffdaac245e4db1720be42d78eefe9825d301"></a>ERROR_TEXT_LANGUAGE_WORD_WRAP&#160;</td><td class="fielddoc"><p>Displays the custom error message with automatic line wrapping and in the specified language. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a6b764f8c4030681ef11c995f2d97adc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b764f8c4030681ef11c995f2d97adc3">&#9670;&nbsp;</a></span>errorCode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void errorCode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structerrorConf.html">errorConf</a> *&#160;</td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>error</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets error code to display. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Pointer to <a class="el" href="structerrorConf.html">errorConf</a>. </td></tr>
<tr><td class="paramname">error</td><td>Error-code to display. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a24660ba95ca3de3aaf9e505bd0f3491b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24660ba95ca3de3aaf9e505bd0f3491b">&#9670;&nbsp;</a></span>errorDisp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void errorDisp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structerrorConf.html">errorConf</a> *&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Displays the error applet. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Pointer to <a class="el" href="structerrorConf.html">errorConf</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1da3d9fb9929410c09ae3c250c804afb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1da3d9fb9929410c09ae3c250c804afb">&#9670;&nbsp;</a></span>errorInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void errorInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structerrorConf.html">errorConf</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="error_8h.html#a0455f547a8d97c35c868b184e0c92ffd">errorType</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="cfgu_8h.html#ac27a9ea95e702ef4a43794b0ac950987">CFG_Language</a>&#160;</td>
<td class="paramname"><em>lang</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Init the error applet. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Pointer to <a class="el" href="structerrorConf.html">errorConf</a>. </td></tr>
<tr><td class="paramname">type</td><td>errorType Type of error. </td></tr>
<tr><td class="paramname">lang</td><td>CFG_Language Lang of error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a30a8a7222331915c0a10901fe8b74f0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30a8a7222331915c0a10901fe8b74f0e">&#9670;&nbsp;</a></span>errorText()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void errorText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structerrorConf.html">errorConf</a> *&#160;</td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>text</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets error text to display. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Pointer to <a class="el" href="structerrorConf.html">errorConf</a>. </td></tr>
<tr><td class="paramname">text</td><td>Error-text to display. </td></tr>
</table>
</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>