152 lines
16 KiB
HTML
152 lines
16 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/fsreg.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">fsreg.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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 fsReg.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief Filesystem registry 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>  </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <<a class="code" href="exheader_8h.html">3ds/exheader.h</a>></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <<a class="code" href="fs_8h.html">3ds/services/fs.h</a>></span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/// Initializes fs:REG.</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> fsRegInit(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/// Exits fs:REG.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span><span class="keywordtype">void</span> fsRegExit(<span class="keywordtype">void</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">/**</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * @brief Gets the current fs:REG session handle.</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * @return The current fs:REG session handle.</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *fsRegGetSessionHandle(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @brief Registers a program's storage information.</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @param pid The Process ID of the program.</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @param programHandle The program handle.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * @param programInfo Information about the program.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * @param storageInfo Storage information to register.</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FSREG_Register(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> pid, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programHandle, <span class="keyword">const</span> <a class="code" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *programInfo, <span class="keyword">const</span> <a class="code" href="structExHeader__Arm11StorageInfo.html">ExHeader_Arm11StorageInfo</a> *storageInfo);</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @brief Unregisters a program's storage information.</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * @param pid The Process ID of the program.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FSREG_Unregister(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> pid);</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @brief Retrives the exheader information set(s) (SCI+ACI) about a program.</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @param exheaderInfos[out] Pointer to the output exheader information set(s).</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @param maxNumEntries The maximum number of entries.</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @param programHandle The program handle.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FSREG_GetProgramInfo(<a class="code" href="structExHeader__Info.html">ExHeader_Info</a> *exheaderInfos, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> maxNumEntries, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programHandle);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @brief Loads a program.</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @param programHandle[out] Pointer to the output the program handle to.</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param programInfo Information about the program to load.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FSREG_LoadProgram(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *programHandle, <span class="keyword">const</span> <a class="code" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *programInfo);</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @brief Unloads a program.</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @param programHandle The program handle.</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FSREG_UnloadProgram(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programHandle);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @brief Checks if a program has been loaded by fs:REG.</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @param programHandle The program handle.</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> FSREG_CheckHostLoadId(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programHandle);</div>
|
|
<div class="ttc" id="aexheader_8h_html"><div class="ttname"><a href="exheader_8h.html">exheader.h</a></div><div class="ttdoc">NCCH extended header definitions.</div></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="astructExHeader__Arm11StorageInfo_html"><div class="ttname"><a href="structExHeader__Arm11StorageInfo.html">ExHeader_Arm11StorageInfo</a></div><div class="ttdoc">The ARM11 filesystem info of a title.</div><div class="ttdef"><b>Definition:</b> exheader.h:120</div></div>
|
|
<div class="ttc" id="astructExHeader__Info_html"><div class="ttname"><a href="structExHeader__Info.html">ExHeader_Info</a></div><div class="ttdoc">Main extended header data, as returned by PXIPM, Loader and FSREG service commands.</div><div class="ttdef"><b>Definition:</b> exheader.h:181</div></div>
|
|
<div class="ttc" id="astructFS__ProgramInfo_html"><div class="ttname"><a href="structFS__ProgramInfo.html">FS_ProgramInfo</a></div><div class="ttdoc">Program information.</div><div class="ttdef"><b>Definition:</b> fs.h:183</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_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>
|