282 lines
54 KiB
HTML
282 lines
54 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/nim.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">nim.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="nim_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 nim.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief NIM (network installation management) 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="comment"> * This service is used to download and install titles from Nintendo's CDN.</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"> * We differentiate between two different kinds of downloads:</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * - "active" downloads, which are downloads started with @ref NIMS_StartDownload or @ref NIMS_StartDownloadSimple. The process must keep polling the current status using @ref NIMS_GetProgress.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * - "tasks", which are downloads started with @ref NIMS_RegisterTask. These are only processed in sleep mode.</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// FS_MediaType</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <<a class="code" href="fs_8h.html">3ds/services/fs.h</a>></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"> 17</span> <span class="comment">/// Mode that NIM downloads/installs a title with.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8"> 18</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8ad02ef05ea4bcac268ab8d4c5d7211d6d"> 20</a></span>  <a class="code" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8ad02ef05ea4bcac268ab8d4c5d7211d6d">IM_DEFAULT</a> = 0, <span class="comment">///< Initial installation</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a67a5609e16b26a010a29809ea2e8061b"> 21</a></span>  <a class="code" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a67a5609e16b26a010a29809ea2e8061b">IM_UNKNOWN1</a>, <span class="comment">///< Unknown</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8afad513e33d908de7591fa5413d9033d5"> 22</a></span>  <a class="code" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8afad513e33d908de7591fa5413d9033d5">IM_UNKNOWN2</a>, <span class="comment">///< Unknown</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a73f9f1db542d2575d1c93c58fc32699a"> 23</a></span>  <a class="code" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a73f9f1db542d2575d1c93c58fc32699a">IM_REINSTALL</a>, <span class="comment">///< Reinstall currently installed title; use this if the title is already installed (including updates)</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> } <a class="code" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a>;</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/// Current state of a NIM download/installation.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99"> 27</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aedc8fb4cc47eb55375aeda921c599480"> 29</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aedc8fb4cc47eb55375aeda921c599480">DS_NOT_INITIALIZED</a> = 0, <span class="comment">///< Download not yet initialized</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aff967378cb9c0d0d6519eb3623868aa6"> 30</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aff967378cb9c0d0d6519eb3623868aa6">DS_INITIALIZED</a>, <span class="comment">///< Download initialized</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a87d7f0d12006b5463b74c3fd2572ab11"> 31</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a87d7f0d12006b5463b74c3fd2572ab11">DS_DOWNLOAD_TMD</a>, <span class="comment">///< Downloading and installing TMD</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8d76690fa959b9214d8a933534b85aad"> 32</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8d76690fa959b9214d8a933534b85aad">DS_PREPARE_SAVE_DATA</a>, <span class="comment">///< Initializing save data</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a5e4f82b39f7bc77de74a33a30b89c425"> 33</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a5e4f82b39f7bc77de74a33a30b89c425">DS_DOWNLOAD_CONTENTS</a>, <span class="comment">///< Downloading and installing contents</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99afdab30cbbb4b07b513f9c3a0675cd452"> 34</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99afdab30cbbb4b07b513f9c3a0675cd452">DS_WAIT_COMMIT</a>, <span class="comment">///< Waiting before calling AM_CommitImportTitles</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43453458305e7a0d446d6815dc8218a8"> 35</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43453458305e7a0d446d6815dc8218a8">DS_COMMITTING</a>, <span class="comment">///< Running AM_CommitImportTitles</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aef98c6ce321fcab9027d734f756cb3e5"> 36</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aef98c6ce321fcab9027d734f756cb3e5">DS_FINISHED</a>, <span class="comment">///< Title installation finished</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8ed24d3e4c6e79c0f895214ae8934c2a"> 37</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8ed24d3e4c6e79c0f895214ae8934c2a">DS_VERSION_ERROR</a>, <span class="comment">///< (unknown error regarding title version)</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43439a49311b0f5c616fe5d9b3bbcba9"> 38</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43439a49311b0f5c616fe5d9b3bbcba9">DS_CREATE_CONTEXT</a>, <span class="comment">///< Creating the .ctx file?</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a0e2a8ccc9b58047bbbd218cfbd1db315"> 39</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a0e2a8ccc9b58047bbbd218cfbd1db315">DS_CANNOT_RECOVER</a>, <span class="comment">///< Irrecoverable error encountered (e.g. out of space)</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a767e5948f84135fa9d2a9e05fe1f3b9e"> 40</a></span>  <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a767e5948f84135fa9d2a9e05fe1f3b9e">DS_INVALID</a>, <span class="comment">///< Invalid state</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> } <a class="code" href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99">NIM_DownloadState</a>;</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">/// Input configuration for NIM download/installation tasks.</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html"> 44</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html#a98d0334cb5c3fba721d6cb0d770bddc9"> 46</a></span>  <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code" href="structNIM__TitleConfig.html#a98d0334cb5c3fba721d6cb0d770bddc9">titleId</a>; <span class="comment">///< Title ID</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html#a5b0a4643706df8115a92b5e8bd11cb48"> 47</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structNIM__TitleConfig.html#a5b0a4643706df8115a92b5e8bd11cb48">version</a>; <span class="comment">///< Title version</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html#abaf56d2b769596bf87b02d4625593169"> 48</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structNIM__TitleConfig.html#abaf56d2b769596bf87b02d4625593169">unknown_0</a>; <span class="comment">///< Always 0</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html#aa900917e9bcbbb5de630a9fef4a5b914"> 49</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structNIM__TitleConfig.html#aa900917e9bcbbb5de630a9fef4a5b914">ratingAge</a>; <span class="comment">///< Age for the HOME Menu parental controls</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html#a61fac82a665ea6fc5495aca1a0fbb6ba"> 50</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structNIM__TitleConfig.html#a61fac82a665ea6fc5495aca1a0fbb6ba">mediaType</a>; <span class="comment">///< Media type, see @ref FS_MediaType enum</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html#aaa758671d7cc933fd9d0f6413f9c9216"> 51</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> padding[2]; <span class="comment">///< Padding</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structNIM__TitleConfig.html#a281f6a23c15a172de892c94a192c2519"> 52</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structNIM__TitleConfig.html#a281f6a23c15a172de892c94a192c2519">unknown_1</a>; <span class="comment">///< Unknown input, seems to be always 0</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <a class="code" href="structNIM__TitleConfig.html">NIM_TitleConfig</a>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/// Output struct for NIM downloads/installations in progress.</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structNIM__TitleProgress.html"> 56</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> {</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structNIM__TitleProgress.html#a2aab196b47b2381cf0093006f88bd14f"> 58</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structNIM__TitleProgress.html#a2aab196b47b2381cf0093006f88bd14f">state</a>; <span class="comment">///< State, see NIM_DownloadState enum</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structNIM__TitleProgress.html#ab3a428ec2477ee4bd75ab781f5b654d1"> 59</a></span>  <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="structNIM__TitleProgress.html#ab3a428ec2477ee4bd75ab781f5b654d1">lastResult</a>; <span class="comment">///< Last result code in NIM</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structNIM__TitleProgress.html#a85833d41dcb3f889e03390cdb042df0f"> 60</a></span>  <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code" href="structNIM__TitleProgress.html#a85833d41dcb3f889e03390cdb042df0f">downloadedSize</a>; <span class="comment">///< Amount of bytes that have been downloaded</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structNIM__TitleProgress.html#a8e999461d7844fd0e50921ef0fd1ffe0"> 61</a></span>  <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code" href="structNIM__TitleProgress.html#a8e999461d7844fd0e50921ef0fd1ffe0">totalSize</a>; <span class="comment">///< Amount of bytes that need to be downloaded in total</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <a class="code" href="structNIM__TitleProgress.html">NIM_TitleProgress</a>;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @brief Initializes nim:s. This uses networking and is blocking.</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @param buffer A buffer for internal use. It must be at least 0x20000 bytes long.</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @param buffer_len Length of the passed buffer.</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="nim_8h.html#aa65aaa1ba6a79aead24799ee7eae042b"> 69</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#aa65aaa1ba6a79aead24799ee7eae042b">nimsInit</a>(<span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> buffer_len);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @brief Initializes nim:s with the given TIN. This uses networking and is blocking.</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @param buffer A buffer for internal use. It must be at least 0x20000 bytes long.</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @param buffer_len Length of the passed buffer.</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @param TIN 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 @ref nimsInit instead.</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="nim_8h.html#a19695db5f26a4bae2adef4e31f3c2288"> 77</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a19695db5f26a4bae2adef4e31f3c2288">nimsInitWithTIN</a>(<span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> buffer_len, <span class="keyword">const</span> <span class="keywordtype">char</span> *TIN);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/// Exits nim:s.</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="nim_8h.html#ab0f1115938ab76c143bf32263c0fe540"> 80</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="nim_8h.html#ab0f1115938ab76c143bf32263c0fe540">nimsExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/// Gets the current nim:s session handle.</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="nim_8h.html#ae12ebc36a717c32ad90685d3b7bd1030"> 83</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *<a class="code" href="nim_8h.html#ae12ebc36a717c32ad90685d3b7bd1030">nimsGetSessionHandle</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @brief Sets an attribute.</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param attr Name of the attribute.</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @param val Value of the attribute.</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="nim_8h.html#a264e9755efb053f7f17a885ed063b1f2"> 90</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a264e9755efb053f7f17a885ed063b1f2">NIMS_SetAttribute</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *attr, <span class="keyword">const</span> <span class="keywordtype">char</span> *val);</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @brief Checks if nim wants a system update.</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @param want_update Set to true if a system update is required. Can be NULL.</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="nim_8h.html#ae79e9ff71afc4b4ab1ca30721c82cff1"> 96</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#ae79e9ff71afc4b4ab1ca30721c82cff1">NIMS_WantUpdate</a>(<span class="keywordtype">bool</span> *want_update);</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * @brief Makes a TitleConfig struct for use with @ref NIMS_RegisterTask, @ref NIMS_StartDownload or @ref NIMS_StartDownloadSimple.</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @param cfg Struct to initialize.</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @param titleId Title ID to download and install.</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param version Version of the title to download and install.</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param ratingAge Age for which the title is aged; used by parental controls in HOME Menu.</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param mediaType Media type of the title to download and install.</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb"> 106</a></span> <span class="keywordtype">void</span> <a class="code" href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb">NIMS_MakeTitleConfig</a>(<a class="code" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleId, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> version, <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> ratingAge, <a class="code" href="fs_8h.html#a3526d37c529b39a862b9b7371a53e137">FS_MediaType</a> mediaType);</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @brief Registers a background download task with NIM. These are processed in sleep mode only.</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @param cfg Title config to use. See @ref NIMS_MakeTitleConfig.</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @param name Name of the title in UTF-8. Will be displayed on the HOME Menu. Maximum 73 characters.</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @param maker Name of the maker/publisher in UTF-8. Will be displayed on the HOME Menu. Maximum 37 characters.</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="nim_8h.html#a527810dd91a67958db3ee33f983cd096"> 114</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a527810dd91a67958db3ee33f983cd096">NIMS_RegisterTask</a>(<span class="keyword">const</span> <a class="code" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *maker);</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @brief Checks whether a background download task for the given title is registered with NIM.</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param titleId Title ID to check for.</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @param registered Whether there is a background download task registered.</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="nim_8h.html#a4b5c1dac154b7404026f80f236b2680e"> 121</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a4b5c1dac154b7404026f80f236b2680e">NIMS_IsTaskRegistered</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleId, <span class="keywordtype">bool</span> *registered);</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @brief Unregisters a background download task.</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @param titleId Title ID whose background download task to cancel.</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="nim_8h.html#a143b0d7bc64225a9880c63f85678ec6d"> 127</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a143b0d7bc64225a9880c63f85678ec6d">NIMS_UnregisterTask</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> titleId);</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @brief Starts an active download with NIM. Progress can be checked with @ref NIMS_GetProcess. Do not exit the process while a download is in progress without calling @ref NIMS_CancelDownload.</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * @param cfg Title config to use. See @ref NIMS_MakeTitleConfig.</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @param mode The installation mode to use. See @ref NIM_InstallationMode.</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3"> 134</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3">NIMS_StartDownload</a>(<span class="keyword">const</span> <a class="code" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg, <a class="code" href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a> mode);</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @brief Starts an active download with NIM with default installation mode; cannot reinstall titles. Progress can be checked with @ref NIMS_GetProcess. Do not exit the process while a download is in progress without calling @ref NIMS_CancelDownload.</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * @param cfg Title config to use. See @ref NIMS_MakeTitleConfig.</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="nim_8h.html#a325728e8375e66624684dad64c9f5e40"> 140</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a325728e8375e66624684dad64c9f5e40">NIMS_StartDownloadSimple</a>(<span class="keyword">const</span> <a class="code" href="structNIM__TitleConfig.html">NIM_TitleConfig</a> *cfg);</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @brief Checks the status of the current active download.</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * @param tp Title progress struct to write to. See @ref NIM_TitleProgress.</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="nim_8h.html#a0ef7f8459de9f4958d1e253e3c694729"> 146</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#a0ef7f8459de9f4958d1e253e3c694729">NIMS_GetProgress</a>(<a class="code" href="structNIM__TitleProgress.html">NIM_TitleProgress</a> *tp);</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @brief Cancels the current active download with NIM.</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="nim_8h.html#acf484fbb6635b63ab2847b296779c9f8"> 151</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="nim_8h.html#acf484fbb6635b63ab2847b296779c9f8">NIMS_CancelDownload</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="ttc" id="afs_8h_html"><div class="ttname"><a href="fs_8h.html">fs.h</a></div><div class="ttdoc">Filesystem Services.</div></div>
|
|
<div class="ttc" id="afs_8h_html_a3526d37c529b39a862b9b7371a53e137"><div class="ttname"><a href="fs_8h.html#a3526d37c529b39a862b9b7371a53e137">FS_MediaType</a></div><div class="ttdeci">FS_MediaType</div><div class="ttdoc">Media types.</div><div class="ttdef"><b>Definition:</b> fs.h:35</div></div>
|
|
<div class="ttc" id="anim_8h_html_a0ef7f8459de9f4958d1e253e3c694729"><div class="ttname"><a href="nim_8h.html#a0ef7f8459de9f4958d1e253e3c694729">NIMS_GetProgress</a></div><div class="ttdeci">Result NIMS_GetProgress(NIM_TitleProgress *tp)</div><div class="ttdoc">Checks the status of the current active download.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a143b0d7bc64225a9880c63f85678ec6d"><div class="ttname"><a href="nim_8h.html#a143b0d7bc64225a9880c63f85678ec6d">NIMS_UnregisterTask</a></div><div class="ttdeci">Result NIMS_UnregisterTask(u64 titleId)</div><div class="ttdoc">Unregisters a background download task.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a19695db5f26a4bae2adef4e31f3c2288"><div class="ttname"><a href="nim_8h.html#a19695db5f26a4bae2adef4e31f3c2288">nimsInitWithTIN</a></div><div class="ttdeci">Result nimsInitWithTIN(void *buffer, size_t buffer_len, const char *TIN)</div><div class="ttdoc">Initializes nim:s with the given TIN.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a264e9755efb053f7f17a885ed063b1f2"><div class="ttname"><a href="nim_8h.html#a264e9755efb053f7f17a885ed063b1f2">NIMS_SetAttribute</a></div><div class="ttdeci">Result NIMS_SetAttribute(const char *attr, const char *val)</div><div class="ttdoc">Sets an attribute.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a325728e8375e66624684dad64c9f5e40"><div class="ttname"><a href="nim_8h.html#a325728e8375e66624684dad64c9f5e40">NIMS_StartDownloadSimple</a></div><div class="ttdeci">Result NIMS_StartDownloadSimple(const NIM_TitleConfig *cfg)</div><div class="ttdoc">Starts an active download with NIM with default installation mode; cannot reinstall titles.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a4b5c1dac154b7404026f80f236b2680e"><div class="ttname"><a href="nim_8h.html#a4b5c1dac154b7404026f80f236b2680e">NIMS_IsTaskRegistered</a></div><div class="ttdeci">Result NIMS_IsTaskRegistered(u64 titleId, bool *registered)</div><div class="ttdoc">Checks whether a background download task for the given title is registered with NIM.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a527810dd91a67958db3ee33f983cd096"><div class="ttname"><a href="nim_8h.html#a527810dd91a67958db3ee33f983cd096">NIMS_RegisterTask</a></div><div class="ttdeci">Result NIMS_RegisterTask(const NIM_TitleConfig *cfg, const char *name, const char *maker)</div><div class="ttdoc">Registers a background download task with NIM.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a61f586836dbf5d41371bd2bd486fe6d3"><div class="ttname"><a href="nim_8h.html#a61f586836dbf5d41371bd2bd486fe6d3">NIMS_StartDownload</a></div><div class="ttdeci">Result NIMS_StartDownload(const NIM_TitleConfig *cfg, NIM_InstallationMode mode)</div><div class="ttdoc">Starts an active download with NIM.</div></div>
|
|
<div class="ttc" id="anim_8h_html_a7857353d69c545e7344ce0bb02c7a3fb"><div class="ttname"><a href="nim_8h.html#a7857353d69c545e7344ce0bb02c7a3fb">NIMS_MakeTitleConfig</a></div><div class="ttdeci">void NIMS_MakeTitleConfig(NIM_TitleConfig *cfg, u64 titleId, u32 version, u8 ratingAge, FS_MediaType mediaType)</div><div class="ttdoc">Makes a TitleConfig struct for use with NIMS_RegisterTask, NIMS_StartDownload or NIMS_StartDownloadSi...</div></div>
|
|
<div class="ttc" id="anim_8h_html_aa65aaa1ba6a79aead24799ee7eae042b"><div class="ttname"><a href="nim_8h.html#aa65aaa1ba6a79aead24799ee7eae042b">nimsInit</a></div><div class="ttdeci">Result nimsInit(void *buffer, size_t buffer_len)</div><div class="ttdoc">Initializes nim:s.</div></div>
|
|
<div class="ttc" id="anim_8h_html_ab0f1115938ab76c143bf32263c0fe540"><div class="ttname"><a href="nim_8h.html#ab0f1115938ab76c143bf32263c0fe540">nimsExit</a></div><div class="ttdeci">void nimsExit(void)</div><div class="ttdoc">Exits nim:s.</div></div>
|
|
<div class="ttc" id="anim_8h_html_acf484fbb6635b63ab2847b296779c9f8"><div class="ttname"><a href="nim_8h.html#acf484fbb6635b63ab2847b296779c9f8">NIMS_CancelDownload</a></div><div class="ttdeci">Result NIMS_CancelDownload(void)</div><div class="ttdoc">Cancels the current active download with NIM.</div></div>
|
|
<div class="ttc" id="anim_8h_html_ae12ebc36a717c32ad90685d3b7bd1030"><div class="ttname"><a href="nim_8h.html#ae12ebc36a717c32ad90685d3b7bd1030">nimsGetSessionHandle</a></div><div class="ttdeci">Handle * nimsGetSessionHandle(void)</div><div class="ttdoc">Gets the current nim:s session handle.</div></div>
|
|
<div class="ttc" id="anim_8h_html_ae79e9ff71afc4b4ab1ca30721c82cff1"><div class="ttname"><a href="nim_8h.html#ae79e9ff71afc4b4ab1ca30721c82cff1">NIMS_WantUpdate</a></div><div class="ttdeci">Result NIMS_WantUpdate(bool *want_update)</div><div class="ttdoc">Checks if nim wants a system update.</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe2032f64d1715e952d818170fc1d8e8"><div class="ttname"><a href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8">NIM_InstallationMode</a></div><div class="ttdeci">NIM_InstallationMode</div><div class="ttdoc">Mode that NIM downloads/installs a title with.</div><div class="ttdef"><b>Definition:</b> nim.h:19</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe2032f64d1715e952d818170fc1d8e8a67a5609e16b26a010a29809ea2e8061b"><div class="ttname"><a href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a67a5609e16b26a010a29809ea2e8061b">IM_UNKNOWN1</a></div><div class="ttdeci">@ IM_UNKNOWN1</div><div class="ttdoc">Unknown.</div><div class="ttdef"><b>Definition:</b> nim.h:21</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe2032f64d1715e952d818170fc1d8e8a73f9f1db542d2575d1c93c58fc32699a"><div class="ttname"><a href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8a73f9f1db542d2575d1c93c58fc32699a">IM_REINSTALL</a></div><div class="ttdeci">@ IM_REINSTALL</div><div class="ttdoc">Reinstall currently installed title; use this if the title is already installed (including updates)</div><div class="ttdef"><b>Definition:</b> nim.h:23</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe2032f64d1715e952d818170fc1d8e8ad02ef05ea4bcac268ab8d4c5d7211d6d"><div class="ttname"><a href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8ad02ef05ea4bcac268ab8d4c5d7211d6d">IM_DEFAULT</a></div><div class="ttdeci">@ IM_DEFAULT</div><div class="ttdoc">Initial installation.</div><div class="ttdef"><b>Definition:</b> nim.h:20</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe2032f64d1715e952d818170fc1d8e8afad513e33d908de7591fa5413d9033d5"><div class="ttname"><a href="nim_8h.html#afe2032f64d1715e952d818170fc1d8e8afad513e33d908de7591fa5413d9033d5">IM_UNKNOWN2</a></div><div class="ttdeci">@ IM_UNKNOWN2</div><div class="ttdoc">Unknown.</div><div class="ttdef"><b>Definition:</b> nim.h:22</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99">NIM_DownloadState</a></div><div class="ttdeci">NIM_DownloadState</div><div class="ttdoc">Current state of a NIM download/installation.</div><div class="ttdef"><b>Definition:</b> nim.h:28</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a0e2a8ccc9b58047bbbd218cfbd1db315"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a0e2a8ccc9b58047bbbd218cfbd1db315">DS_CANNOT_RECOVER</a></div><div class="ttdeci">@ DS_CANNOT_RECOVER</div><div class="ttdoc">Irrecoverable error encountered (e.g. out of space)</div><div class="ttdef"><b>Definition:</b> nim.h:39</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a43439a49311b0f5c616fe5d9b3bbcba9"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43439a49311b0f5c616fe5d9b3bbcba9">DS_CREATE_CONTEXT</a></div><div class="ttdeci">@ DS_CREATE_CONTEXT</div><div class="ttdoc">Creating the .ctx file?</div><div class="ttdef"><b>Definition:</b> nim.h:38</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a43453458305e7a0d446d6815dc8218a8"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a43453458305e7a0d446d6815dc8218a8">DS_COMMITTING</a></div><div class="ttdeci">@ DS_COMMITTING</div><div class="ttdoc">Running AM_CommitImportTitles.</div><div class="ttdef"><b>Definition:</b> nim.h:35</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a5e4f82b39f7bc77de74a33a30b89c425"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a5e4f82b39f7bc77de74a33a30b89c425">DS_DOWNLOAD_CONTENTS</a></div><div class="ttdeci">@ DS_DOWNLOAD_CONTENTS</div><div class="ttdoc">Downloading and installing contents.</div><div class="ttdef"><b>Definition:</b> nim.h:33</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a767e5948f84135fa9d2a9e05fe1f3b9e"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a767e5948f84135fa9d2a9e05fe1f3b9e">DS_INVALID</a></div><div class="ttdeci">@ DS_INVALID</div><div class="ttdoc">Invalid state.</div><div class="ttdef"><b>Definition:</b> nim.h:40</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a87d7f0d12006b5463b74c3fd2572ab11"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a87d7f0d12006b5463b74c3fd2572ab11">DS_DOWNLOAD_TMD</a></div><div class="ttdeci">@ DS_DOWNLOAD_TMD</div><div class="ttdoc">Downloading and installing TMD.</div><div class="ttdef"><b>Definition:</b> nim.h:31</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a8d76690fa959b9214d8a933534b85aad"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8d76690fa959b9214d8a933534b85aad">DS_PREPARE_SAVE_DATA</a></div><div class="ttdeci">@ DS_PREPARE_SAVE_DATA</div><div class="ttdoc">Initializing save data.</div><div class="ttdef"><b>Definition:</b> nim.h:32</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99a8ed24d3e4c6e79c0f895214ae8934c2a"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99a8ed24d3e4c6e79c0f895214ae8934c2a">DS_VERSION_ERROR</a></div><div class="ttdeci">@ DS_VERSION_ERROR</div><div class="ttdoc">(unknown error regarding title version)</div><div class="ttdef"><b>Definition:</b> nim.h:37</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99aedc8fb4cc47eb55375aeda921c599480"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aedc8fb4cc47eb55375aeda921c599480">DS_NOT_INITIALIZED</a></div><div class="ttdeci">@ DS_NOT_INITIALIZED</div><div class="ttdoc">Download not yet initialized.</div><div class="ttdef"><b>Definition:</b> nim.h:29</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99aef98c6ce321fcab9027d734f756cb3e5"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aef98c6ce321fcab9027d734f756cb3e5">DS_FINISHED</a></div><div class="ttdeci">@ DS_FINISHED</div><div class="ttdoc">Title installation finished.</div><div class="ttdef"><b>Definition:</b> nim.h:36</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99afdab30cbbb4b07b513f9c3a0675cd452"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99afdab30cbbb4b07b513f9c3a0675cd452">DS_WAIT_COMMIT</a></div><div class="ttdeci">@ DS_WAIT_COMMIT</div><div class="ttdoc">Waiting before calling AM_CommitImportTitles.</div><div class="ttdef"><b>Definition:</b> nim.h:34</div></div>
|
|
<div class="ttc" id="anim_8h_html_afe21b8e82d3ea0c25ee8d00e9accdc99aff967378cb9c0d0d6519eb3623868aa6"><div class="ttname"><a href="nim_8h.html#afe21b8e82d3ea0c25ee8d00e9accdc99aff967378cb9c0d0d6519eb3623868aa6">DS_INITIALIZED</a></div><div class="ttdeci">@ DS_INITIALIZED</div><div class="ttdoc">Download initialized.</div><div class="ttdef"><b>Definition:</b> nim.h:30</div></div>
|
|
<div class="ttc" id="astructNIM__TitleConfig_html"><div class="ttname"><a href="structNIM__TitleConfig.html">NIM_TitleConfig</a></div><div class="ttdoc">Input configuration for NIM download/installation tasks.</div><div class="ttdef"><b>Definition:</b> nim.h:45</div></div>
|
|
<div class="ttc" id="astructNIM__TitleConfig_html_a281f6a23c15a172de892c94a192c2519"><div class="ttname"><a href="structNIM__TitleConfig.html#a281f6a23c15a172de892c94a192c2519">NIM_TitleConfig::unknown_1</a></div><div class="ttdeci">u32 unknown_1</div><div class="ttdoc">Unknown input, seems to be always 0.</div><div class="ttdef"><b>Definition:</b> nim.h:52</div></div>
|
|
<div class="ttc" id="astructNIM__TitleConfig_html_a5b0a4643706df8115a92b5e8bd11cb48"><div class="ttname"><a href="structNIM__TitleConfig.html#a5b0a4643706df8115a92b5e8bd11cb48">NIM_TitleConfig::version</a></div><div class="ttdeci">u32 version</div><div class="ttdoc">Title version.</div><div class="ttdef"><b>Definition:</b> nim.h:47</div></div>
|
|
<div class="ttc" id="astructNIM__TitleConfig_html_a61fac82a665ea6fc5495aca1a0fbb6ba"><div class="ttname"><a href="structNIM__TitleConfig.html#a61fac82a665ea6fc5495aca1a0fbb6ba">NIM_TitleConfig::mediaType</a></div><div class="ttdeci">u8 mediaType</div><div class="ttdoc">Media type, see FS_MediaType enum.</div><div class="ttdef"><b>Definition:</b> nim.h:50</div></div>
|
|
<div class="ttc" id="astructNIM__TitleConfig_html_a98d0334cb5c3fba721d6cb0d770bddc9"><div class="ttname"><a href="structNIM__TitleConfig.html#a98d0334cb5c3fba721d6cb0d770bddc9">NIM_TitleConfig::titleId</a></div><div class="ttdeci">u64 titleId</div><div class="ttdoc">Title ID.</div><div class="ttdef"><b>Definition:</b> nim.h:46</div></div>
|
|
<div class="ttc" id="astructNIM__TitleConfig_html_aa900917e9bcbbb5de630a9fef4a5b914"><div class="ttname"><a href="structNIM__TitleConfig.html#aa900917e9bcbbb5de630a9fef4a5b914">NIM_TitleConfig::ratingAge</a></div><div class="ttdeci">u8 ratingAge</div><div class="ttdoc">Age for the HOME Menu parental controls.</div><div class="ttdef"><b>Definition:</b> nim.h:49</div></div>
|
|
<div class="ttc" id="astructNIM__TitleConfig_html_abaf56d2b769596bf87b02d4625593169"><div class="ttname"><a href="structNIM__TitleConfig.html#abaf56d2b769596bf87b02d4625593169">NIM_TitleConfig::unknown_0</a></div><div class="ttdeci">u32 unknown_0</div><div class="ttdoc">Always 0.</div><div class="ttdef"><b>Definition:</b> nim.h:48</div></div>
|
|
<div class="ttc" id="astructNIM__TitleProgress_html"><div class="ttname"><a href="structNIM__TitleProgress.html">NIM_TitleProgress</a></div><div class="ttdoc">Output struct for NIM downloads/installations in progress.</div><div class="ttdef"><b>Definition:</b> nim.h:57</div></div>
|
|
<div class="ttc" id="astructNIM__TitleProgress_html_a2aab196b47b2381cf0093006f88bd14f"><div class="ttname"><a href="structNIM__TitleProgress.html#a2aab196b47b2381cf0093006f88bd14f">NIM_TitleProgress::state</a></div><div class="ttdeci">u32 state</div><div class="ttdoc">State, see NIM_DownloadState enum.</div><div class="ttdef"><b>Definition:</b> nim.h:58</div></div>
|
|
<div class="ttc" id="astructNIM__TitleProgress_html_a85833d41dcb3f889e03390cdb042df0f"><div class="ttname"><a href="structNIM__TitleProgress.html#a85833d41dcb3f889e03390cdb042df0f">NIM_TitleProgress::downloadedSize</a></div><div class="ttdeci">u64 downloadedSize</div><div class="ttdoc">Amount of bytes that have been downloaded.</div><div class="ttdef"><b>Definition:</b> nim.h:60</div></div>
|
|
<div class="ttc" id="astructNIM__TitleProgress_html_a8e999461d7844fd0e50921ef0fd1ffe0"><div class="ttname"><a href="structNIM__TitleProgress.html#a8e999461d7844fd0e50921ef0fd1ffe0">NIM_TitleProgress::totalSize</a></div><div class="ttdeci">u64 totalSize</div><div class="ttdoc">Amount of bytes that need to be downloaded in total.</div><div class="ttdef"><b>Definition:</b> nim.h:61</div></div>
|
|
<div class="ttc" id="astructNIM__TitleProgress_html_ab3a428ec2477ee4bd75ab781f5b654d1"><div class="ttname"><a href="structNIM__TitleProgress.html#ab3a428ec2477ee4bd75ab781f5b654d1">NIM_TitleProgress::lastResult</a></div><div class="ttdeci">Result lastResult</div><div class="ttdoc">Last result code in NIM.</div><div class="ttdef"><b>Definition:</b> nim.h:59</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_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</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>
|