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

274 lines
16 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/romfs.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">romfs.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>RomFS driver.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="types_8h_source.html">3ds/types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="fs_8h_source.html">3ds/services/fs.h</a>&gt;</code><br />
</div>
<p><a href="romfs_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="structromfs__header.html">romfs_header</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">RomFS header. <a href="structromfs__header.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="structromfs__dir.html">romfs_dir</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">RomFS directory. <a href="structromfs__dir.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="structromfs__file.html">romfs_file</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">RomFS file. <a href="structromfs__file.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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a996532140f972ebd60dded2dd409396d"><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="romfs_8h.html#a996532140f972ebd60dded2dd409396d">romfsMountSelf</a> (const char *name)</td></tr>
<tr class="memdesc:a996532140f972ebd60dded2dd409396d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mounts the Application's RomFS. <a href="romfs_8h.html#a996532140f972ebd60dded2dd409396d">More...</a><br /></td></tr>
<tr class="separator:a996532140f972ebd60dded2dd409396d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ce254a38954ddb78e99c2bb7a16a0b9"><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="romfs_8h.html#a6ce254a38954ddb78e99c2bb7a16a0b9">romfsMountFromFile</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> fd, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> offset, const char *name)</td></tr>
<tr class="memdesc:a6ce254a38954ddb78e99c2bb7a16a0b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mounts RomFS from an open file. <a href="romfs_8h.html#a6ce254a38954ddb78e99c2bb7a16a0b9">More...</a><br /></td></tr>
<tr class="separator:a6ce254a38954ddb78e99c2bb7a16a0b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30019781595267e9a1396a5a5387bf45"><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="romfs_8h.html#a30019781595267e9a1396a5a5387bf45">romfsMountFromCurrentProcess</a> (const char *name)</td></tr>
<tr class="memdesc:a30019781595267e9a1396a5a5387bf45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mounts RomFS using the current process host program RomFS. <a href="romfs_8h.html#a30019781595267e9a1396a5a5387bf45">More...</a><br /></td></tr>
<tr class="separator:a30019781595267e9a1396a5a5387bf45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27853e37c0edae46b91d0d50b9c6d267"><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="romfs_8h.html#a27853e37c0edae46b91d0d50b9c6d267">romfsMountFromTitle</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> tid, <a class="el" href="fs_8h.html#a3526d37c529b39a862b9b7371a53e137">FS_MediaType</a> mediatype, const char *name)</td></tr>
<tr class="memdesc:a27853e37c0edae46b91d0d50b9c6d267"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mounts RomFS from the specified title. <a href="romfs_8h.html#a27853e37c0edae46b91d0d50b9c6d267">More...</a><br /></td></tr>
<tr class="separator:a27853e37c0edae46b91d0d50b9c6d267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1dd7a7a199e7d6f40a3530820212357"><td class="memItemLeft" align="right" valign="top"><a id="ad1dd7a7a199e7d6f40a3530820212357"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="romfs_8h.html#ad1dd7a7a199e7d6f40a3530820212357">romfsUnmount</a> (const char *name)</td></tr>
<tr class="memdesc:ad1dd7a7a199e7d6f40a3530820212357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unmounts the RomFS device. <br /></td></tr>
<tr class="separator:ad1dd7a7a199e7d6f40a3530820212357"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12e06b453b9b7bc98333702553572574"><td class="memItemLeft" align="right" valign="top"><a id="a12e06b453b9b7bc98333702553572574"></a>
static <a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="romfs_8h.html#a12e06b453b9b7bc98333702553572574">romfsInit</a> (void)</td></tr>
<tr class="memdesc:a12e06b453b9b7bc98333702553572574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper for <a class="el" href="romfs_8h.html#a996532140f972ebd60dded2dd409396d">romfsMountSelf</a> with the default "romfs" device name. <br /></td></tr>
<tr class="separator:a12e06b453b9b7bc98333702553572574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0b28376bd1c13790398fc00fedd2feb"><td class="memItemLeft" align="right" valign="top"><a id="ab0b28376bd1c13790398fc00fedd2feb"></a>
static <a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="romfs_8h.html#ab0b28376bd1c13790398fc00fedd2feb">romfsExit</a> (void)</td></tr>
<tr class="memdesc:ab0b28376bd1c13790398fc00fedd2feb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper for <a class="el" href="romfs_8h.html#ad1dd7a7a199e7d6f40a3530820212357">romfsUnmount</a> with the default "romfs" device name. <br /></td></tr>
<tr class="separator:ab0b28376bd1c13790398fc00fedd2feb"><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>RomFS driver. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a30019781595267e9a1396a5a5387bf45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30019781595267e9a1396a5a5387bf45">&#9670;&nbsp;</a></span>romfsMountFromCurrentProcess()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> romfsMountFromCurrentProcess </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mounts RomFS using the current process host program RomFS. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Device mount name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6ce254a38954ddb78e99c2bb7a16a0b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ce254a38954ddb78e99c2bb7a16a0b9">&#9670;&nbsp;</a></span>romfsMountFromFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> romfsMountFromFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td>
<td class="paramname"><em>fd</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>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mounts RomFS from an open file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>FSFILE handle of the RomFS image. </td></tr>
<tr><td class="paramname">offset</td><td>Offset of the RomFS within the file. </td></tr>
<tr><td class="paramname">name</td><td>Device mount name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a27853e37c0edae46b91d0d50b9c6d267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27853e37c0edae46b91d0d50b9c6d267">&#9670;&nbsp;</a></span>romfsMountFromTitle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> romfsMountFromTitle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>tid</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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mounts RomFS from the specified title. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tid</td><td>Title ID </td></tr>
<tr><td class="paramname">mediatype</td><td>Mediatype </td></tr>
<tr><td class="paramname">name</td><td>Device mount name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a996532140f972ebd60dded2dd409396d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a996532140f972ebd60dded2dd409396d">&#9670;&nbsp;</a></span>romfsMountSelf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> romfsMountSelf </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mounts the Application's RomFS. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Device mount name. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>This function is intended to be used to access one's own RomFS. If the application is running as 3DSX, it mounts the embedded RomFS section inside the 3DSX. If on the other hand it's an NCCH, it behaves identically to <a class="el" href="romfs_8h.html#a30019781595267e9a1396a5a5387bf45">romfsMountFromCurrentProcess</a>. </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