306 lines
17 KiB
HTML
306 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 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
|
|
 <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="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ns.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>NS (Nintendo Shell) service.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="ns_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="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:aa3e020968b46610d05db16f1249a6650"><td class="memItemLeft" align="right" valign="top"><a id="aa3e020968b46610d05db16f1249a6650"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#aa3e020968b46610d05db16f1249a6650">nsInit</a> (void)</td></tr>
|
|
<tr class="memdesc:aa3e020968b46610d05db16f1249a6650"><td class="mdescLeft"> </td><td class="mdescRight">Initializes NS. <br /></td></tr>
|
|
<tr class="separator:aa3e020968b46610d05db16f1249a6650"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a410b45f7f12874e4ccf6bc21e80e4568"><td class="memItemLeft" align="right" valign="top"><a id="a410b45f7f12874e4ccf6bc21e80e4568"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#a410b45f7f12874e4ccf6bc21e80e4568">nsExit</a> (void)</td></tr>
|
|
<tr class="memdesc:a410b45f7f12874e4ccf6bc21e80e4568"><td class="mdescLeft"> </td><td class="mdescRight">Exits NS. <br /></td></tr>
|
|
<tr class="separator:a410b45f7f12874e4ccf6bc21e80e4568"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a918d9ee332a423e8b0ac9c7fd7043781"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#a918d9ee332a423e8b0ac9c7fd7043781">NS_LaunchFIRM</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid)</td></tr>
|
|
<tr class="memdesc:a918d9ee332a423e8b0ac9c7fd7043781"><td class="mdescLeft"> </td><td class="mdescRight">Launches a title and the required firmware (only if necessary). <a href="ns_8h.html#a918d9ee332a423e8b0ac9c7fd7043781">More...</a><br /></td></tr>
|
|
<tr class="separator:a918d9ee332a423e8b0ac9c7fd7043781"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a9f9fa41eae5ab2378c1ab269ad0a96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#a6a9f9fa41eae5ab2378c1ab269ad0a96">NS_LaunchTitle</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> launch_flags, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *procid)</td></tr>
|
|
<tr class="memdesc:a6a9f9fa41eae5ab2378c1ab269ad0a96"><td class="mdescLeft"> </td><td class="mdescRight">Launches a title. <a href="ns_8h.html#a6a9f9fa41eae5ab2378c1ab269ad0a96">More...</a><br /></td></tr>
|
|
<tr class="separator:a6a9f9fa41eae5ab2378c1ab269ad0a96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c6a744f3bb54027c9d40b0e72b4bfae"><td class="memItemLeft" align="right" valign="top"><a id="a7c6a744f3bb54027c9d40b0e72b4bfae"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#a7c6a744f3bb54027c9d40b0e72b4bfae">NS_TerminateTitle</a> (void)</td></tr>
|
|
<tr class="memdesc:a7c6a744f3bb54027c9d40b0e72b4bfae"><td class="mdescLeft"> </td><td class="mdescRight">Terminates the application from which this function is called. <br /></td></tr>
|
|
<tr class="separator:a7c6a744f3bb54027c9d40b0e72b4bfae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01293499195c2b40a46bf68941008fd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#a01293499195c2b40a46bf68941008fd6">NS_LaunchApplicationFIRM</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> flags)</td></tr>
|
|
<tr class="memdesc:a01293499195c2b40a46bf68941008fd6"><td class="mdescLeft"> </td><td class="mdescRight">Launches a title and the required firmware. <a href="ns_8h.html#a01293499195c2b40a46bf68941008fd6">More...</a><br /></td></tr>
|
|
<tr class="separator:a01293499195c2b40a46bf68941008fd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06e05e3cb511baecbb7a6d245c188df0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#a06e05e3cb511baecbb7a6d245c188df0">NS_RebootToTitle</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> mediatype, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid)</td></tr>
|
|
<tr class="memdesc:a06e05e3cb511baecbb7a6d245c188df0"><td class="mdescLeft"> </td><td class="mdescRight">Reboots to a title. <a href="ns_8h.html#a06e05e3cb511baecbb7a6d245c188df0">More...</a><br /></td></tr>
|
|
<tr class="separator:a06e05e3cb511baecbb7a6d245c188df0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa451e546d4aa3cb2692767f0a20c63c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#aa451e546d4aa3cb2692767f0a20c63c3">NS_TerminateProcessTID</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleid, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout)</td></tr>
|
|
<tr class="memdesc:aa451e546d4aa3cb2692767f0a20c63c3"><td class="mdescLeft"> </td><td class="mdescRight">Terminates the process with the specified titleid. <a href="ns_8h.html#aa451e546d4aa3cb2692767f0a20c63c3">More...</a><br /></td></tr>
|
|
<tr class="separator:aa451e546d4aa3cb2692767f0a20c63c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31e34f83a443c013f62393050638a581"><td class="memItemLeft" align="right" valign="top"><a id="a31e34f83a443c013f62393050638a581"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ns_8h.html#a31e34f83a443c013f62393050638a581">NS_RebootSystem</a> (void)</td></tr>
|
|
<tr class="memdesc:a31e34f83a443c013f62393050638a581"><td class="mdescLeft"> </td><td class="mdescRight">Reboots the system. <br /></td></tr>
|
|
<tr class="separator:a31e34f83a443c013f62393050638a581"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>NS (Nintendo Shell) service. </p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a01293499195c2b40a46bf68941008fd6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a01293499195c2b40a46bf68941008fd6">◆ </a></span>NS_LaunchApplicationFIRM()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NS_LaunchApplicationFIRM </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>titleid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>flags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Launches a title and the required firmware. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">titleid</td><td>ID of the title to launch, 0 for gamecard. </td></tr>
|
|
<tr><td class="paramname">flags</td><td>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. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a918d9ee332a423e8b0ac9c7fd7043781"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a918d9ee332a423e8b0ac9c7fd7043781">◆ </a></span>NS_LaunchFIRM()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NS_LaunchFIRM </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>titleid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Launches a title and the required firmware (only if necessary). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">titleid</td><td>ID of the title to launch, 0 for gamecard, JPN System Settings' titleID for System Settings. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6a9f9fa41eae5ab2378c1ab269ad0a96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a9f9fa41eae5ab2378c1ab269ad0a96">◆ </a></span>NS_LaunchTitle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NS_LaunchTitle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>titleid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>launch_flags</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>procid</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Launches a title. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">titleid</td><td>ID of the title to launch, or 0 for gamecard. </td></tr>
|
|
<tr><td class="paramname">launch_flags</td><td>Flags used when launching the title. </td></tr>
|
|
<tr><td class="paramname">procid</td><td>Pointer to write the process ID of the launched title to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a06e05e3cb511baecbb7a6d245c188df0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06e05e3cb511baecbb7a6d245c188df0">◆ </a></span>NS_RebootToTitle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NS_RebootToTitle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> </td>
|
|
<td class="paramname"><em>mediatype</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>titleid</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reboots to a title. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mediatype</td><td>Mediatype of the title. </td></tr>
|
|
<tr><td class="paramname">titleid</td><td>ID of the title to launch. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa451e546d4aa3cb2692767f0a20c63c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa451e546d4aa3cb2692767f0a20c63c3">◆ </a></span>NS_TerminateProcessTID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NS_TerminateProcessTID </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>titleid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminates the process with the specified titleid. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">titleid</td><td>ID of the title to terminate. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Timeout in nanoseconds. Pass 0 if not required. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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>
|