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

667 lines
40 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/services/nim.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_0e005207343684f6967052d1f51a7e66.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">nim.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>NIM (network installation management) service.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="fs_8h_source.html">3ds/services/fs.h</a>&gt;</code><br />
</div>
<p><a href="nim_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="structNIM__TitleConfig.html">NIM_TitleConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input configuration for NIM download/installation tasks. <a href="structNIM__TitleConfig.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="structNIM__TitleProgress.html">NIM_TitleProgress</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output struct for NIM downloads/installations in progress. <a href="structNIM__TitleProgress.html#details">More...</a><br /></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:afe2032f64d1715e952d818170fc1d8e8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a> { <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8ad02ef05ea4bcac268ab8d4c5d7211d6d">IM_DEFAULT</a> = 0
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a67a5609e16b26a010a29809ea2e8061b">IM_UNKNOWN1</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8afad513e33d908de7591fa5413d9033d5">IM_UNKNOWN2</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a73f9f1db542d2575d1c93c58fc32699a">IM_REINSTALL</a>
<br />
}</td></tr>
<tr class="memdesc:afe2032f64d1715e952d818170fc1d8e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mode that NIM downloads/installs a title with. <a href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">More...</a><br /></td></tr>
<tr class="separator:afe2032f64d1715e952d818170fc1d8e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe21b8e82d3ea0c25ee8d00e9accdc99"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99">NIM_DownloadState</a> { <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aedc8fb4cc47eb55375aeda921c599480">DS_NOT_INITIALIZED</a> = 0
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aff967378cb9c0d0d6519eb3623868aa6">DS_INITIALIZED</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a87d7f0d12006b5463b74c3fd2572ab11">DS_DOWNLOAD_TMD</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8d76690fa959b9214d8a933534b85aad">DS_PREPARE_SAVE_DATA</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a5e4f82b39f7bc77de74a33a30b89c425">DS_DOWNLOAD_CONTENTS</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99afdab30cbbb4b07b513f9c3a0675cd452">DS_WAIT_COMMIT</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43453458305e7a0d446d6815dc8218a8">DS_COMMITTING</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aef98c6ce321fcab9027d734f756cb3e5">DS_FINISHED</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8ed24d3e4c6e79c0f895214ae8934c2a">DS_VERSION_ERROR</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43439a49311b0f5c616fe5d9b3bbcba9">DS_CREATE_CONTEXT</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a0e2a8ccc9b58047bbbd218cfbd1db315">DS_CANNOT_RECOVER</a>
, <br />
&#160;&#160;<a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a767e5948f84135fa9d2a9e05fe1f3b9e">DS_INVALID</a>
<br />
}</td></tr>
<tr class="memdesc:afe21b8e82d3ea0c25ee8d00e9accdc99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current state of a NIM download/installation. <a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99">More...</a><br /></td></tr>
<tr class="separator:afe21b8e82d3ea0c25ee8d00e9accdc99"><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:aa65aaa1ba6a79aead24799ee7eae042b"><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="nim_8h.html#aa65aaa1ba6a79aead24799ee7eae042b">nimsInit</a> (void *buffer, size_t buffer_len)</td></tr>
<tr class="memdesc:aa65aaa1ba6a79aead24799ee7eae042b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes nim:s. <a href="nim_8h.html#aa65aaa1ba6a79aead24799ee7eae042b">More...</a><br /></td></tr>
<tr class="separator:aa65aaa1ba6a79aead24799ee7eae042b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19695db5f26a4bae2adef4e31f3c2288"><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="nim_8h.html#a19695db5f26a4bae2adef4e31f3c2288">nimsInitWithTIN</a> (void *buffer, size_t buffer_len, const char *TIN)</td></tr>
<tr class="memdesc:a19695db5f26a4bae2adef4e31f3c2288"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes nim:s with the given TIN. <a href="nim_8h.html#a19695db5f26a4bae2adef4e31f3c2288">More...</a><br /></td></tr>
<tr class="separator:a19695db5f26a4bae2adef4e31f3c2288"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0f1115938ab76c143bf32263c0fe540"><td class="memItemLeft" align="right" valign="top"><a id="ab0f1115938ab76c143bf32263c0fe540"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="nim_8h.html#ab0f1115938ab76c143bf32263c0fe540">nimsExit</a> (void)</td></tr>
<tr class="memdesc:ab0f1115938ab76c143bf32263c0fe540"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits nim:s. <br /></td></tr>
<tr class="separator:ab0f1115938ab76c143bf32263c0fe540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae12ebc36a717c32ad90685d3b7bd1030"><td class="memItemLeft" align="right" valign="top"><a id="ae12ebc36a717c32ad90685d3b7bd1030"></a>
<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="nim_8h.html#ae12ebc36a717c32ad90685d3b7bd1030">nimsGetSessionHandle</a> (void)</td></tr>
<tr class="memdesc:ae12ebc36a717c32ad90685d3b7bd1030"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current nim:s session handle. <br /></td></tr>
<tr class="separator:ae12ebc36a717c32ad90685d3b7bd1030"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a264e9755efb053f7f17a885ed063b1f2"><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="nim_8h.html#a264e9755efb053f7f17a885ed063b1f2">NIMS_SetAttribute</a> (const char *attr, const char *val)</td></tr>
<tr class="memdesc:a264e9755efb053f7f17a885ed063b1f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets an attribute. <a href="nim_8h.html#a264e9755efb053f7f17a885ed063b1f2">More...</a><br /></td></tr>
<tr class="separator:a264e9755efb053f7f17a885ed063b1f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae79e9ff71afc4b4ab1ca30721c82cff1"><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="nim_8h.html#ae79e9ff71afc4b4ab1ca30721c82cff1">NIMS_WantUpdate</a> (bool *want_update)</td></tr>
<tr class="memdesc:ae79e9ff71afc4b4ab1ca30721c82cff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if nim wants a system update. <a href="nim_8h.html#ae79e9ff71afc4b4ab1ca30721c82cff1">More...</a><br /></td></tr>
<tr class="separator:ae79e9ff71afc4b4ab1ca30721c82cff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7857353d69c545e7344ce0bb02c7a3fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb">NIMS_MakeTitleConfig</a> (<a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleId, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> version, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> ratingAge, <a class="el" href="fs_8h.html#a3526d37c529b39a862b9b7371a53e137">FS_MediaType</a> mediaType)</td></tr>
<tr class="memdesc:a7857353d69c545e7344ce0bb02c7a3fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes a TitleConfig struct for use with <a class="el" href="nim_8h.html#a527810dd91a67958db3ee33f983cd096">NIMS_RegisterTask</a>, <a class="el" href="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3">NIMS_StartDownload</a> or <a class="el" href="nim_8h.html#a325728e8375e66624684dad64c9f5e40">NIMS_StartDownloadSimple</a>. <a href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb">More...</a><br /></td></tr>
<tr class="separator:a7857353d69c545e7344ce0bb02c7a3fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a527810dd91a67958db3ee33f983cd096"><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="nim_8h.html#a527810dd91a67958db3ee33f983cd096">NIMS_RegisterTask</a> (const <a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg, const char *name, const char *maker)</td></tr>
<tr class="memdesc:a527810dd91a67958db3ee33f983cd096"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a background download task with NIM. <a href="nim_8h.html#a527810dd91a67958db3ee33f983cd096">More...</a><br /></td></tr>
<tr class="separator:a527810dd91a67958db3ee33f983cd096"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b5c1dac154b7404026f80f236b2680e"><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="nim_8h.html#a4b5c1dac154b7404026f80f236b2680e">NIMS_IsTaskRegistered</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleId, bool *registered)</td></tr>
<tr class="memdesc:a4b5c1dac154b7404026f80f236b2680e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether a background download task for the given title is registered with NIM. <a href="nim_8h.html#a4b5c1dac154b7404026f80f236b2680e">More...</a><br /></td></tr>
<tr class="separator:a4b5c1dac154b7404026f80f236b2680e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a143b0d7bc64225a9880c63f85678ec6d"><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="nim_8h.html#a143b0d7bc64225a9880c63f85678ec6d">NIMS_UnregisterTask</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleId)</td></tr>
<tr class="memdesc:a143b0d7bc64225a9880c63f85678ec6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters a background download task. <a href="nim_8h.html#a143b0d7bc64225a9880c63f85678ec6d">More...</a><br /></td></tr>
<tr class="separator:a143b0d7bc64225a9880c63f85678ec6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61f586836dbf5d41371bd2bd486fe6d3"><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="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3">NIMS_StartDownload</a> (const <a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg, <a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a> mode)</td></tr>
<tr class="memdesc:a61f586836dbf5d41371bd2bd486fe6d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts an active download with NIM. <a href="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3">More...</a><br /></td></tr>
<tr class="separator:a61f586836dbf5d41371bd2bd486fe6d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a325728e8375e66624684dad64c9f5e40"><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="nim_8h.html#a325728e8375e66624684dad64c9f5e40">NIMS_StartDownloadSimple</a> (const <a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg)</td></tr>
<tr class="memdesc:a325728e8375e66624684dad64c9f5e40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts an active download with NIM with default installation mode; cannot reinstall titles. <a href="nim_8h.html#a325728e8375e66624684dad64c9f5e40">More...</a><br /></td></tr>
<tr class="separator:a325728e8375e66624684dad64c9f5e40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ef7f8459de9f4958d1e253e3c694729"><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="nim_8h.html#a0ef7f8459de9f4958d1e253e3c694729">NIMS_GetProgress</a> (<a class="el" href="structNIM__TitleProgress.html">NIM_TitleProgress</a> *tp)</td></tr>
<tr class="memdesc:a0ef7f8459de9f4958d1e253e3c694729"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the status of the current active download. <a href="nim_8h.html#a0ef7f8459de9f4958d1e253e3c694729">More...</a><br /></td></tr>
<tr class="separator:a0ef7f8459de9f4958d1e253e3c694729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf484fbb6635b63ab2847b296779c9f8"><td class="memItemLeft" align="right" valign="top"><a id="acf484fbb6635b63ab2847b296779c9f8"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="nim_8h.html#acf484fbb6635b63ab2847b296779c9f8">NIMS_CancelDownload</a> (void)</td></tr>
<tr class="memdesc:acf484fbb6635b63ab2847b296779c9f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancels the current active download with NIM. <br /></td></tr>
<tr class="separator:acf484fbb6635b63ab2847b296779c9f8"><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>NIM (network installation management) service. </p>
<p>This service is used to download and install titles from Nintendo's CDN.</p>
<p>We differentiate between two different kinds of downloads:</p>
<ul>
<li>"active" downloads, which are downloads started with <a class="el" href="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3">NIMS_StartDownload</a> or <a class="el" href="nim_8h.html#a325728e8375e66624684dad64c9f5e40">NIMS_StartDownloadSimple</a>. The process must keep polling the current status using <a class="el" href="nim_8h.html#a0ef7f8459de9f4958d1e253e3c694729">NIMS_GetProgress</a>.</li>
<li>"tasks", which are downloads started with <a class="el" href="nim_8h.html#a527810dd91a67958db3ee33f983cd096">NIMS_RegisterTask</a>. These are only processed in sleep mode. </li>
</ul>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="afe21b8e82d3ea0c25ee8d00e9accdc99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe21b8e82d3ea0c25ee8d00e9accdc99">&#9670;&nbsp;</a></span>NIM_DownloadState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99">NIM_DownloadState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Current state of a NIM download/installation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99aedc8fb4cc47eb55375aeda921c599480"></a>DS_NOT_INITIALIZED&#160;</td><td class="fielddoc"><p>Download not yet initialized. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99aff967378cb9c0d0d6519eb3623868aa6"></a>DS_INITIALIZED&#160;</td><td class="fielddoc"><p>Download initialized. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a87d7f0d12006b5463b74c3fd2572ab11"></a>DS_DOWNLOAD_TMD&#160;</td><td class="fielddoc"><p>Downloading and installing TMD. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a8d76690fa959b9214d8a933534b85aad"></a>DS_PREPARE_SAVE_DATA&#160;</td><td class="fielddoc"><p>Initializing save data. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a5e4f82b39f7bc77de74a33a30b89c425"></a>DS_DOWNLOAD_CONTENTS&#160;</td><td class="fielddoc"><p>Downloading and installing contents. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99afdab30cbbb4b07b513f9c3a0675cd452"></a>DS_WAIT_COMMIT&#160;</td><td class="fielddoc"><p>Waiting before calling AM_CommitImportTitles. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a43453458305e7a0d446d6815dc8218a8"></a>DS_COMMITTING&#160;</td><td class="fielddoc"><p>Running AM_CommitImportTitles. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99aef98c6ce321fcab9027d734f756cb3e5"></a>DS_FINISHED&#160;</td><td class="fielddoc"><p>Title installation finished. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a8ed24d3e4c6e79c0f895214ae8934c2a"></a>DS_VERSION_ERROR&#160;</td><td class="fielddoc"><p>(unknown error regarding title version) </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a43439a49311b0f5c616fe5d9b3bbcba9"></a>DS_CREATE_CONTEXT&#160;</td><td class="fielddoc"><p>Creating the .ctx file? </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a0e2a8ccc9b58047bbbd218cfbd1db315"></a>DS_CANNOT_RECOVER&#160;</td><td class="fielddoc"><p>Irrecoverable error encountered (e.g. out of space) </p>
</td></tr>
<tr><td class="fieldname"><a id="afe21b8e82d3ea0c25ee8d00e9accdc99a767e5948f84135fa9d2a9e05fe1f3b9e"></a>DS_INVALID&#160;</td><td class="fielddoc"><p>Invalid state. </p>
</td></tr>
</table>
</div>
</div>
<a id="afe2032f64d1715e952d818170fc1d8e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe2032f64d1715e952d818170fc1d8e8">&#9670;&nbsp;</a></span>NIM_InstallationMode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mode that NIM downloads/installs a title with. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="afe2032f64d1715e952d818170fc1d8e8ad02ef05ea4bcac268ab8d4c5d7211d6d"></a>IM_DEFAULT&#160;</td><td class="fielddoc"><p>Initial installation. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe2032f64d1715e952d818170fc1d8e8a67a5609e16b26a010a29809ea2e8061b"></a>IM_UNKNOWN1&#160;</td><td class="fielddoc"><p>Unknown. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe2032f64d1715e952d818170fc1d8e8afad513e33d908de7591fa5413d9033d5"></a>IM_UNKNOWN2&#160;</td><td class="fielddoc"><p>Unknown. </p>
</td></tr>
<tr><td class="fieldname"><a id="afe2032f64d1715e952d818170fc1d8e8a73f9f1db542d2575d1c93c58fc32699a"></a>IM_REINSTALL&#160;</td><td class="fielddoc"><p>Reinstall currently installed title; use this if the title is already installed (including updates) </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0ef7f8459de9f4958d1e253e3c694729"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ef7f8459de9f4958d1e253e3c694729">&#9670;&nbsp;</a></span>NIMS_GetProgress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_GetProgress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structNIM__TitleProgress.html">NIM_TitleProgress</a> *&#160;</td>
<td class="paramname"><em>tp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the status of the current active download. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tp</td><td>Title progress struct to write to. See <a class="el" href="structNIM__TitleProgress.html">NIM_TitleProgress</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4b5c1dac154b7404026f80f236b2680e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b5c1dac154b7404026f80f236b2680e">&#9670;&nbsp;</a></span>NIMS_IsTaskRegistered()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_IsTaskRegistered </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>titleId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>registered</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a background download task for the given title is registered with NIM. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">titleId</td><td>Title ID to check for. </td></tr>
<tr><td class="paramname">registered</td><td>Whether there is a background download task registered. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7857353d69c545e7344ce0bb02c7a3fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7857353d69c545e7344ce0bb02c7a3fb">&#9670;&nbsp;</a></span>NIMS_MakeTitleConfig()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NIMS_MakeTitleConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *&#160;</td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</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>&#160;</td>
<td class="paramname"><em>version</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>ratingAge</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="fs_8h.html#a3526d37c529b39a862b9b7371a53e137">FS_MediaType</a>&#160;</td>
<td class="paramname"><em>mediaType</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a TitleConfig struct for use with <a class="el" href="nim_8h.html#a527810dd91a67958db3ee33f983cd096">NIMS_RegisterTask</a>, <a class="el" href="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3">NIMS_StartDownload</a> or <a class="el" href="nim_8h.html#a325728e8375e66624684dad64c9f5e40">NIMS_StartDownloadSimple</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>Struct to initialize. </td></tr>
<tr><td class="paramname">titleId</td><td>Title ID to download and install. </td></tr>
<tr><td class="paramname">version</td><td>Version of the title to download and install. </td></tr>
<tr><td class="paramname">ratingAge</td><td>Age for which the title is aged; used by parental controls in HOME Menu. </td></tr>
<tr><td class="paramname">mediaType</td><td>Media type of the title to download and install. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a527810dd91a67958db3ee33f983cd096"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a527810dd91a67958db3ee33f983cd096">&#9670;&nbsp;</a></span>NIMS_RegisterTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_RegisterTask </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *&#160;</td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>maker</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a background download task with NIM. </p>
<p>These are processed in sleep mode only. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>Title config to use. See <a class="el" href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb">NIMS_MakeTitleConfig</a>. </td></tr>
<tr><td class="paramname">name</td><td>Name of the title in UTF-8. Will be displayed on the HOME Menu. Maximum 73 characters. </td></tr>
<tr><td class="paramname">maker</td><td>Name of the maker/publisher in UTF-8. Will be displayed on the HOME Menu. Maximum 37 characters. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a264e9755efb053f7f17a885ed063b1f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a264e9755efb053f7f17a885ed063b1f2">&#9670;&nbsp;</a></span>NIMS_SetAttribute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_SetAttribute </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets an attribute. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>Name of the attribute. </td></tr>
<tr><td class="paramname">val</td><td>Value of the attribute. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a61f586836dbf5d41371bd2bd486fe6d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61f586836dbf5d41371bd2bd486fe6d3">&#9670;&nbsp;</a></span>NIMS_StartDownload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_StartDownload </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *&#160;</td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a>&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an active download with NIM. </p>
<p>Progress can be checked with NIMS_GetProcess. Do not exit the process while a download is in progress without calling <a class="el" href="nim_8h.html#acf484fbb6635b63ab2847b296779c9f8">NIMS_CancelDownload</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>Title config to use. See <a class="el" href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb">NIMS_MakeTitleConfig</a>. </td></tr>
<tr><td class="paramname">mode</td><td>The installation mode to use. See <a class="el" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a325728e8375e66624684dad64c9f5e40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a325728e8375e66624684dad64c9f5e40">&#9670;&nbsp;</a></span>NIMS_StartDownloadSimple()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_StartDownloadSimple </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *&#160;</td>
<td class="paramname"><em>cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an active download with NIM with default installation mode; cannot reinstall titles. </p>
<p>Progress can be checked with NIMS_GetProcess. Do not exit the process while a download is in progress without calling <a class="el" href="nim_8h.html#acf484fbb6635b63ab2847b296779c9f8">NIMS_CancelDownload</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>Title config to use. See <a class="el" href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb">NIMS_MakeTitleConfig</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a143b0d7bc64225a9880c63f85678ec6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a143b0d7bc64225a9880c63f85678ec6d">&#9670;&nbsp;</a></span>NIMS_UnregisterTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_UnregisterTask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>titleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregisters a background download task. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">titleId</td><td>Title ID whose background download task to cancel. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae79e9ff71afc4b4ab1ca30721c82cff1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae79e9ff71afc4b4ab1ca30721c82cff1">&#9670;&nbsp;</a></span>NIMS_WantUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> NIMS_WantUpdate </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>want_update</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if nim wants a system update. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">want_update</td><td>Set to true if a system update is required. Can be NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa65aaa1ba6a79aead24799ee7eae042b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa65aaa1ba6a79aead24799ee7eae042b">&#9670;&nbsp;</a></span>nimsInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nimsInit </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>buffer_len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes nim:s. </p>
<p>This uses networking and is blocking. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>A buffer for internal use. It must be at least 0x20000 bytes long. </td></tr>
<tr><td class="paramname">buffer_len</td><td>Length of the passed buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a19695db5f26a4bae2adef4e31f3c2288"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19695db5f26a4bae2adef4e31f3c2288">&#9670;&nbsp;</a></span>nimsInitWithTIN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nimsInitWithTIN </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>buffer_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>TIN</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes nim:s with the given TIN. </p>
<p>This uses networking and is blocking. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>A buffer for internal use. It must be at least 0x20000 bytes long. </td></tr>
<tr><td class="paramname">buffer_len</td><td>Length of the passed buffer. </td></tr>
<tr><td class="paramname">TIN</td><td>The TIN to initialize nim:s with. If you do not know what a TIN is or why you would want to change it, use <a class="el" href="nim_8h.html#aa65aaa1ba6a79aead24799ee7eae042b">nimsInit</a> instead. </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>
Reference in New Issue View Git Blame Copy Permalink