DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
e52f3175e1
libctru/archive_8h_source.html

142 lines
18 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ 8cbcce773b957684577b3a77c42d2c2864b016af 🚀
2024-11-03 21:36:34 +01:00
<!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/archive.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
&#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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">archive.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="archive_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>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * @file archive.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * @brief FS_Archive driver</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;sys/types.h&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="types_8h.html">3ds/types.h</a>&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="fs_8h.html">3ds/services/fs.h</a>&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define ARCHIVE_DIRITER_MAGIC 0x68637261 </span><span class="comment">/* &quot;arch&quot; */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">/*! Open directory struct */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structarchive__dir__t.html"> 15</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> magic; <span class="comment">/*! &quot;arch&quot; */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structarchive__dir__t.html#a9554e472c1c0d61cb42dbc94eb3ebead"> 18</a></span>&#160; <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code" href="structarchive__dir__t.html#a9554e472c1c0d61cb42dbc94eb3ebead">fd</a>; <span class="comment">/*! CTRU handle */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structarchive__dir__t.html#a8dcad37586509976c812a79253ccb9f2"> 19</a></span>&#160; ssize_t <a class="code" href="structarchive__dir__t.html#a8dcad37586509976c812a79253ccb9f2">index</a>; <span class="comment">/*! Current entry index */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structarchive__dir__t.html#a370ff6f78589cec3468132a2c1a9ede8"> 20</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structarchive__dir__t.html#a370ff6f78589cec3468132a2c1a9ede8">size</a>; <span class="comment">/*! Current batch size */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structarchive__dir__t.html#a3271a4553a27455a4dc1865c9a8daf63"> 21</a></span>&#160; <a class="code" href="structFS__DirectoryEntry.html">FS_DirectoryEntry</a> entry_data[32]; <span class="comment">/*! Temporary storage for reading entries */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;} <a class="code" href="structarchive__dir__t.html">archive_dir_t</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/// Mounts the SD</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="archive_8h.html#aa89a086cebbb92b3293b203071489eb8"> 25</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="archive_8h.html#aa89a086cebbb92b3293b203071489eb8">archiveMountSdmc</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/// Mounts and opens an archive as deviceName</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">/// Returns either an archive open error code, or -1 for generic failure</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="archive_8h.html#adbc4b0c3e005f2a443b5283b623a7b1f"> 29</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="archive_8h.html#adbc4b0c3e005f2a443b5283b623a7b1f">archiveMount</a>(<a class="code" href="fs_8h.html#a24416208e0f4c6c6efc3b2118a2d8803">FS_ArchiveID</a> archiveID, <a class="code" href="structFS__Path.html">FS_Path</a> archivePath, <span class="keyword">const</span> <span class="keywordtype">char</span> *deviceName);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">/// Uses FSUSER_ControlArchive with control action ARCHIVE_ACTION_COMMIT_SAVE_DATA on the opened archive. Not done automatically at unmount.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">/// Returns -1 if the specified device is not found</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="archive_8h.html#ad1bf0c6ab382b2fdb308b674c89ec6dc"> 33</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="archive_8h.html#ad1bf0c6ab382b2fdb308b674c89ec6dc">archiveCommitSaveData</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *deviceName);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">/// Unmounts the specified device, closing its archive in the process</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">/// Returns -1 if the specified device was not found</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="archive_8h.html#a5f89a397a31710375697b51e9f43e45f"> 37</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="archive_8h.html#a5f89a397a31710375697b51e9f43e45f">archiveUnmount</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *deviceName);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">/// Unmounts all devices and cleans up any resources used by the driver</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="archive_8h.html#aea64551a14815c6499d00eb12cd38388"> 40</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="archive_8h.html#aea64551a14815c6499d00eb12cd38388">archiveUnmountAll</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">/// Get a file&#39;s mtime</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="archive_8h.html#ae08e5e05c5940a70a931ee2c5202108a"> 43</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="archive_8h.html#ae08e5e05c5940a70a931ee2c5202108a">archive_getmtime</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *mtime);</div>
<div class="ttc" id="aarchive_8h_html_a5f89a397a31710375697b51e9f43e45f"><div class="ttname"><a href="archive_8h.html#a5f89a397a31710375697b51e9f43e45f">archiveUnmount</a></div><div class="ttdeci">Result archiveUnmount(const char *deviceName)</div><div class="ttdoc">Unmounts the specified device, closing its archive in the process Returns -1 if the specified device ...</div></div>
<div class="ttc" id="aarchive_8h_html_aa89a086cebbb92b3293b203071489eb8"><div class="ttname"><a href="archive_8h.html#aa89a086cebbb92b3293b203071489eb8">archiveMountSdmc</a></div><div class="ttdeci">Result archiveMountSdmc(void)</div><div class="ttdoc">Mounts the SD.</div></div>
<div class="ttc" id="aarchive_8h_html_ad1bf0c6ab382b2fdb308b674c89ec6dc"><div class="ttname"><a href="archive_8h.html#ad1bf0c6ab382b2fdb308b674c89ec6dc">archiveCommitSaveData</a></div><div class="ttdeci">Result archiveCommitSaveData(const char *deviceName)</div><div class="ttdoc">Uses FSUSER_ControlArchive with control action ARCHIVE_ACTION_COMMIT_SAVE_DATA on the opened archive.</div></div>
<div class="ttc" id="aarchive_8h_html_adbc4b0c3e005f2a443b5283b623a7b1f"><div class="ttname"><a href="archive_8h.html#adbc4b0c3e005f2a443b5283b623a7b1f">archiveMount</a></div><div class="ttdeci">Result archiveMount(FS_ArchiveID archiveID, FS_Path archivePath, const char *deviceName)</div><div class="ttdoc">Mounts and opens an archive as deviceName Returns either an archive open error code,...</div></div>
<div class="ttc" id="aarchive_8h_html_ae08e5e05c5940a70a931ee2c5202108a"><div class="ttname"><a href="archive_8h.html#ae08e5e05c5940a70a931ee2c5202108a">archive_getmtime</a></div><div class="ttdeci">Result archive_getmtime(const char *name, u64 *mtime)</div><div class="ttdoc">Get a file's mtime.</div></div>
<div class="ttc" id="aarchive_8h_html_aea64551a14815c6499d00eb12cd38388"><div class="ttname"><a href="archive_8h.html#aea64551a14815c6499d00eb12cd38388">archiveUnmountAll</a></div><div class="ttdeci">Result archiveUnmountAll(void)</div><div class="ttdoc">Unmounts all devices and cleans up any resources used by the driver.</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="afs_8h_html_a24416208e0f4c6c6efc3b2118a2d8803"><div class="ttname"><a href="fs_8h.html#a24416208e0f4c6c6efc3b2118a2d8803">FS_ArchiveID</a></div><div class="ttdeci">FS_ArchiveID</div><div class="ttdoc">Archive IDs.</div><div class="ttdef"><b>Definition:</b> fs.h:52</div></div>
<div class="ttc" id="astructFS__DirectoryEntry_html"><div class="ttname"><a href="structFS__DirectoryEntry.html">FS_DirectoryEntry</a></div><div class="ttdoc">Directory entry.</div><div class="ttdef"><b>Definition:</b> fs.h:162</div></div>
<div class="ttc" id="astructFS__Path_html"><div class="ttname"><a href="structFS__Path.html">FS_Path</a></div><div class="ttdoc">Filesystem path data, detailing the specific target of an operation.</div><div class="ttdef"><b>Definition:</b> fs.h:232</div></div>
<div class="ttc" id="astructarchive__dir__t_html"><div class="ttname"><a href="structarchive__dir__t.html">archive_dir_t</a></div><div class="ttdoc">Open directory struct.</div><div class="ttdef"><b>Definition:</b> archive.h:16</div></div>
<div class="ttc" id="astructarchive__dir__t_html_a370ff6f78589cec3468132a2c1a9ede8"><div class="ttname"><a href="structarchive__dir__t.html#a370ff6f78589cec3468132a2c1a9ede8">archive_dir_t::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Current entry index.</div><div class="ttdef"><b>Definition:</b> archive.h:20</div></div>
<div class="ttc" id="astructarchive__dir__t_html_a8dcad37586509976c812a79253ccb9f2"><div class="ttname"><a href="structarchive__dir__t.html#a8dcad37586509976c812a79253ccb9f2">archive_dir_t::index</a></div><div class="ttdeci">ssize_t index</div><div class="ttdoc">CTRU handle.</div><div class="ttdef"><b>Definition:</b> archive.h:19</div></div>
<div class="ttc" id="astructarchive__dir__t_html_a9554e472c1c0d61cb42dbc94eb3ebead"><div class="ttname"><a href="structarchive__dir__t.html#a9554e472c1c0d61cb42dbc94eb3ebead">archive_dir_t::fd</a></div><div class="ttdeci">Handle fd</div><div class="ttdoc">&quot;arch&quot;</div><div class="ttdef"><b>Definition:</b> archive.h:18</div></div>
<div class="ttc" id="atypes_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">Various system types.</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&#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 Copy Permalink