144 lines
17 KiB
HTML
144 lines
17 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/services/ns.h Source File</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
|
|
 <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&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&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_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">ns.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ns_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file ns.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief NS (Nintendo Shell) service.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/// Initializes NS.</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="ns_8h.html#aa3e020968b46610d05db16f1249a6650"> 8</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#aa3e020968b46610d05db16f1249a6650">nsInit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/// Exits NS.</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="ns_8h.html#a410b45f7f12874e4ccf6bc21e80e4568"> 11</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="ns_8h.html#a410b45f7f12874e4ccf6bc21e80e4568">nsExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * @brief Launches a title and the required firmware (only if necessary).</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * @param titleid ID of the title to launch, 0 for gamecard, JPN System Settings' titleID for System Settings.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="ns_8h.html#a918d9ee332a423e8b0ac9c7fd7043781"> 17</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#a918d9ee332a423e8b0ac9c7fd7043781">NS_LaunchFIRM</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid);</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @brief Launches a title.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @param titleid ID of the title to launch, or 0 for gamecard.</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @param launch_flags Flags used when launching the title.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @param procid Pointer to write the process ID of the launched title to.</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="ns_8h.html#a6a9f9fa41eae5ab2378c1ab269ad0a96"> 25</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#a6a9f9fa41eae5ab2378c1ab269ad0a96">NS_LaunchTitle</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> launch_flags, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *procid);</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/// Terminates the application from which this function is called</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="ns_8h.html#a7c6a744f3bb54027c9d40b0e72b4bfae"> 28</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#a7c6a744f3bb54027c9d40b0e72b4bfae">NS_TerminateTitle</a>(<span class="keywordtype">void</span>);<span class="comment"></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @brief Launches a title and the required firmware.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @param titleid ID of the title to launch, 0 for gamecard.</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @param flags Flags for firm-launch. bit0: require an application title-info structure in FIRM paramters to be specified via FIRM parameters. bit1: if clear, NS will check certain Configuration Memory fields.</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="ns_8h.html#a01293499195c2b40a46bf68941008fd6"> 34</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#a01293499195c2b40a46bf68941008fd6">NS_LaunchApplicationFIRM</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> flags);</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @brief Reboots to a title.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @param mediatype Mediatype of the title.</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @param titleid ID of the title to launch.</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="ns_8h.html#a06e05e3cb511baecbb7a6d245c188df0"> 41</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#a06e05e3cb511baecbb7a6d245c188df0">NS_RebootToTitle</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> mediatype, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @brief Terminates the process with the specified titleid.</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @param titleid ID of the title to terminate.</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * @param timeout Timeout in nanoseconds. Pass 0 if not required.</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="ns_8h.html#aa451e546d4aa3cb2692767f0a20c63c3"> 48</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#aa451e546d4aa3cb2692767f0a20c63c3">NS_TerminateProcessTID</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout);</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/// Reboots the system</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="ns_8h.html#a31e34f83a443c013f62393050638a581"> 51</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ns_8h.html#a31e34f83a443c013f62393050638a581">NS_RebootSystem</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="ttc" id="ans_8h_html_a01293499195c2b40a46bf68941008fd6"><div class="ttname"><a href="ns_8h.html#a01293499195c2b40a46bf68941008fd6">NS_LaunchApplicationFIRM</a></div><div class="ttdeci">Result NS_LaunchApplicationFIRM(u64 titleid, u32 flags)</div><div class="ttdoc">Launches a title and the required firmware.</div></div>
|
|
<div class="ttc" id="ans_8h_html_a06e05e3cb511baecbb7a6d245c188df0"><div class="ttname"><a href="ns_8h.html#a06e05e3cb511baecbb7a6d245c188df0">NS_RebootToTitle</a></div><div class="ttdeci">Result NS_RebootToTitle(u8 mediatype, u64 titleid)</div><div class="ttdoc">Reboots to a title.</div></div>
|
|
<div class="ttc" id="ans_8h_html_a31e34f83a443c013f62393050638a581"><div class="ttname"><a href="ns_8h.html#a31e34f83a443c013f62393050638a581">NS_RebootSystem</a></div><div class="ttdeci">Result NS_RebootSystem(void)</div><div class="ttdoc">Reboots the system.</div></div>
|
|
<div class="ttc" id="ans_8h_html_a410b45f7f12874e4ccf6bc21e80e4568"><div class="ttname"><a href="ns_8h.html#a410b45f7f12874e4ccf6bc21e80e4568">nsExit</a></div><div class="ttdeci">void nsExit(void)</div><div class="ttdoc">Exits NS.</div></div>
|
|
<div class="ttc" id="ans_8h_html_a6a9f9fa41eae5ab2378c1ab269ad0a96"><div class="ttname"><a href="ns_8h.html#a6a9f9fa41eae5ab2378c1ab269ad0a96">NS_LaunchTitle</a></div><div class="ttdeci">Result NS_LaunchTitle(u64 titleid, u32 launch_flags, u32 *procid)</div><div class="ttdoc">Launches a title.</div></div>
|
|
<div class="ttc" id="ans_8h_html_a7c6a744f3bb54027c9d40b0e72b4bfae"><div class="ttname"><a href="ns_8h.html#a7c6a744f3bb54027c9d40b0e72b4bfae">NS_TerminateTitle</a></div><div class="ttdeci">Result NS_TerminateTitle(void)</div><div class="ttdoc">Terminates the application from which this function is called.</div></div>
|
|
<div class="ttc" id="ans_8h_html_a918d9ee332a423e8b0ac9c7fd7043781"><div class="ttname"><a href="ns_8h.html#a918d9ee332a423e8b0ac9c7fd7043781">NS_LaunchFIRM</a></div><div class="ttdeci">Result NS_LaunchFIRM(u64 titleid)</div><div class="ttdoc">Launches a title and the required firmware (only if necessary).</div></div>
|
|
<div class="ttc" id="ans_8h_html_aa3e020968b46610d05db16f1249a6650"><div class="ttname"><a href="ns_8h.html#aa3e020968b46610d05db16f1249a6650">nsInit</a></div><div class="ttdeci">Result nsInit(void)</div><div class="ttdoc">Initializes NS.</div></div>
|
|
<div class="ttc" id="ans_8h_html_aa451e546d4aa3cb2692767f0a20c63c3"><div class="ttname"><a href="ns_8h.html#aa451e546d4aa3cb2692767f0a20c63c3">NS_TerminateProcessTID</a></div><div class="ttdeci">Result NS_TerminateProcessTID(u64 titleid, u64 timeout)</div><div class="ttdoc">Terminates the process with the specified titleid.</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:24</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|