mirror of
https://github.com/switchbrew/libnx.git
synced 2025-07-03 01:52:14 +02:00
225 lines
39 KiB
HTML
225 lines
39 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libnx: include/switch/runtime/devices/fs_dev.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">libnx<span id="projectnumber"> v4.9.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_afd0453aeaaca58db0f3a26ffe540381.html">runtime</a></li><li class="navelem"><a class="el" href="dir_8e84a2b4adc47392539d92413dc3768e.html">devices</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">fs_dev.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="fs__dev_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file fs_dev.h</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief FS driver, using devoptab.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author yellows8</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @author mtheall</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * @copyright libnx Authors</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <sys/types.h></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "../../services/fs.h"</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#ad6e9d067a702af02a3d353ae34c0689e"> 13</a></span><span class="preprocessor">#define FSDEV_DIRITER_MAGIC 0x66736476 </span><span class="comment">///< "fsdv"</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">/// Open directory struct</span></div>
|
|
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html"> 16</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>{</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#a5fcbe07d06351a9efcfa2ce4e762af16"> 18</a></span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code hl_variable" href="structfsdev__dir__t.html#a5fcbe07d06351a9efcfa2ce4e762af16">magic</a>; <span class="comment">///< "fsdv"</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#a644adafed15480977127f5e4b222550c"> 19</a></span> <a class="code hl_struct" href="structFsDir.html">FsDir</a> <a class="code hl_variable" href="structfsdev__dir__t.html#a644adafed15480977127f5e4b222550c">fd</a>; <span class="comment">///< File descriptor</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#af603e154cdaaa7b6c3d3cd233cf1e914"> 20</a></span> ssize_t <a class="code hl_variable" href="structfsdev__dir__t.html#af603e154cdaaa7b6c3d3cd233cf1e914">index</a>; <span class="comment">///< Current entry index</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#a2b6a04ec1a69f845865a00d461611aa3"> 21</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structfsdev__dir__t.html#a2b6a04ec1a69f845865a00d461611aa3">size</a>; <span class="comment">///< Current batch size</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>} <a class="code hl_struct" href="structfsdev__dir__t.html">fsdev_dir_t</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">/// Retrieves a pointer to temporary stage for reading entries</span></div>
|
|
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a96949c9646025f0eadda87ca74532bcd"> 25</a></span><span class="comment"></span><a class="code hl_define" href="types_8h.html#ae2a0903442f062ed4f9f0568a6f1a297">NX_CONSTEXPR</a> <a class="code hl_struct" href="structFsDirectoryEntry.html">FsDirectoryEntry</a>* <a class="code hl_function" href="fs__dev_8h.html#a96949c9646025f0eadda87ca74532bcd">fsdevDirGetEntries</a>(<a class="code hl_struct" href="structfsdev__dir__t.html">fsdev_dir_t</a> *dir)</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>{</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">return</span> (<a class="code hl_struct" href="structFsDirectoryEntry.html">FsDirectoryEntry</a>*)(<span class="keywordtype">void</span>*)(dir+1);</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/// Initializes and mounts the sdmc device if accessible.</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#adbb4e3052a264aac8de47b53f3e41327"> 31</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#adbb4e3052a264aac8de47b53f3e41327">fsdevMountSdmc</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">/// Mounts the specified SaveData.</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#ac1b778fe6a4634dbdb3ad36faf627ed0"> 34</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#ac1b778fe6a4634dbdb3ad36faf627ed0">fsdevMountSaveData</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> application_id, <a class="code hl_struct" href="structAccountUid.html">AccountUid</a> uid);</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">/// Mounts the specified SaveData as ReadOnly.</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">/// Only available on [2.0.0+].</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a02c6091e771294f638e132f84c774d78"> 38</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a02c6091e771294f638e132f84c774d78">fsdevMountSaveDataReadOnly</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> application_id, <a class="code hl_struct" href="structAccountUid.html">AccountUid</a> uid);</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">/// Mounts the specified BcatSaveData.</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a4c0501b352109acfdfcd65636bfaee16"> 41</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a4c0501b352109acfdfcd65636bfaee16">fsdevMountBcatSaveData</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> application_id);</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">/// Mounts the specified DeviceSaveData.</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a8ed81cedbe85fc0526584a675870bfb0"> 44</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a8ed81cedbe85fc0526584a675870bfb0">fsdevMountDeviceSaveData</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> application_id);</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">/// Mounts the TemporaryStorage for the current process.</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">/// Only available on [3.0.0+].</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a3353161a28735023bf6dfdfb0dc1eaf2"> 48</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a3353161a28735023bf6dfdfb0dc1eaf2">fsdevMountTemporaryStorage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment">/// Mounts the specified CacheStorage.</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment">/// Only available on [3.0.0+].</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a4b793945795e850a589fbb9b70b51891"> 52</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a4b793945795e850a589fbb9b70b51891">fsdevMountCacheStorage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> application_id, <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> save_data_index);</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">/// Mounts the specified SystemSaveData.</span></div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a4ba58c9994c656c5feecc78ce84c2656"> 55</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a4ba58c9994c656c5feecc78ce84c2656">fsdevMountSystemSaveData</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_enumeration" href="fs_8h.html#a8499196753de89e06a45dd7226dd4f09">FsSaveDataSpaceId</a> save_data_space_id, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> system_save_data_id, <a class="code hl_struct" href="structAccountUid.html">AccountUid</a> uid);</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment">/// Mounts the specified SystemBcatSaveData.</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment">/// Only available on [4.0.0+].</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#ae8143f14b60430787055c1c031758a63"> 59</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#ae8143f14b60430787055c1c031758a63">fsdevMountSystemBcatSaveData</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> system_save_data_id);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment">/// Mounts the input fs with the specified device name. fsdev will handle closing the fs when required, including when fsdevMountDevice() fails.</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">/// Returns -1 when any errors occur.</span></div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">/// Input device name string shouldn't exceed 31 characters, and shouldn't have a trailing colon.</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a9e65c89226ab22ed62eb9776896ede2f"> 64</a></span><span class="comment"></span><span class="keywordtype">int</span> <a class="code hl_function" href="fs__dev_8h.html#a9e65c89226ab22ed62eb9776896ede2f">fsdevMountDevice</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_struct" href="structFsFileSystem.html">FsFileSystem</a> fs);</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment">/// Unmounts the specified device.</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#ad5bd2af2a4d2a011f431bf2c0d1679f2"> 67</a></span><span class="comment"></span><span class="keywordtype">int</span> <a class="code hl_function" href="fs__dev_8h.html#ad5bd2af2a4d2a011f431bf2c0d1679f2">fsdevUnmountDevice</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">/// Uses fsFsCommit() with the specified device. This must be used after any savedata-write operations(not just file-write). This should be used after each file-close where file-writing was done.</span></div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment">/// This is not used automatically at device unmount.</span></div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#aa9634b8f9ff2c8e3ad90e6f8e2906a14"> 71</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#aa9634b8f9ff2c8e3ad90e6f8e2906a14">fsdevCommitDevice</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">/// Returns the FsFileSystem for the specified device. Returns NULL when the specified device isn't found.</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a5cbc1f6539fba9280dd09e5ad2fefbd7"> 74</a></span><span class="comment"></span><a class="code hl_struct" href="structFsFileSystem.html">FsFileSystem</a>* <a class="code hl_function" href="fs__dev_8h.html#a5cbc1f6539fba9280dd09e5ad2fefbd7">fsdevGetDeviceFileSystem</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment">/// Writes the FS-path to outpath (which has buffer size FS_MAX_PATH), for the input path (as used in stdio). The FsFileSystem is also written to device when not NULL.</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a1b0083e28e5d68af286827116ae82e72"> 77</a></span><span class="comment"></span><span class="keywordtype">int</span> <a class="code hl_function" href="fs__dev_8h.html#a1b0083e28e5d68af286827116ae82e72">fsdevTranslatePath</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <a class="code hl_struct" href="structFsFileSystem.html">FsFileSystem</a>** device, <span class="keywordtype">char</span> *outpath);</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment">/// This calls fsFsSetConcatenationFileAttribute on the filesystem specified by the input path (as used in stdio).</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a74b5f3323ca7a4b4cef5afc216fef092"> 80</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a74b5f3323ca7a4b4cef5afc216fef092">fsdevSetConcatenationFileAttribute</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">// Uses \ref fsFsIsValidSignedSystemPartitionOnSdCard with the specified device.</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> fsdevIsValidSignedSystemPartitionOnSdCard(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">bool</span> *out);</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment">/// This calls fsFsCreateFile on the filesystem specified by the input path (as used in stdio).</span></div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a68b5d4d1ae75a896cee80dbf941f1008"> 86</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a68b5d4d1ae75a896cee80dbf941f1008">fsdevCreateFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* path, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> flags);</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment">/// Recursively deletes the directory specified by the input path (as used in stdio).</span></div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a16f9fe08fcafe6c6d32fa22a84321c4d"> 89</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a16f9fe08fcafe6c6d32fa22a84321c4d">fsdevDeleteDirectoryRecursively</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment">/// Unmounts all devices and cleans up any resources used by the FS driver.</span></div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#ad13800ff0e52530283b410ed3ec03d3c"> 92</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#ad13800ff0e52530283b410ed3ec03d3c">fsdevUnmountAll</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment">/// Retrieves the last native result code generated during a failed fsdev operation.</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#a57244b19f36077b91ce22f019dbcc941"> 95</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="fs__dev_8h.html#a57244b19f36077b91ce22f019dbcc941">fsdevGetLastResult</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="ttc" id="afs_8h_html_a8499196753de89e06a45dd7226dd4f09"><div class="ttname"><a href="fs_8h.html#a8499196753de89e06a45dd7226dd4f09">FsSaveDataSpaceId</a></div><div class="ttdeci">FsSaveDataSpaceId</div><div class="ttdoc">SaveDataSpaceId.</div><div class="ttdef"><b>Definition</b> fs.h:205</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a02c6091e771294f638e132f84c774d78"><div class="ttname"><a href="fs__dev_8h.html#a02c6091e771294f638e132f84c774d78">fsdevMountSaveDataReadOnly</a></div><div class="ttdeci">Result fsdevMountSaveDataReadOnly(const char *name, u64 application_id, AccountUid uid)</div><div class="ttdoc">Mounts the specified SaveData as ReadOnly.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a16f9fe08fcafe6c6d32fa22a84321c4d"><div class="ttname"><a href="fs__dev_8h.html#a16f9fe08fcafe6c6d32fa22a84321c4d">fsdevDeleteDirectoryRecursively</a></div><div class="ttdeci">Result fsdevDeleteDirectoryRecursively(const char *path)</div><div class="ttdoc">Recursively deletes the directory specified by the input path (as used in stdio).</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a1b0083e28e5d68af286827116ae82e72"><div class="ttname"><a href="fs__dev_8h.html#a1b0083e28e5d68af286827116ae82e72">fsdevTranslatePath</a></div><div class="ttdeci">int fsdevTranslatePath(const char *path, FsFileSystem **device, char *outpath)</div><div class="ttdoc">Writes the FS-path to outpath (which has buffer size FS_MAX_PATH), for the input path (as used in std...</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a3353161a28735023bf6dfdfb0dc1eaf2"><div class="ttname"><a href="fs__dev_8h.html#a3353161a28735023bf6dfdfb0dc1eaf2">fsdevMountTemporaryStorage</a></div><div class="ttdeci">Result fsdevMountTemporaryStorage(const char *name)</div><div class="ttdoc">Mounts the TemporaryStorage for the current process.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a4b793945795e850a589fbb9b70b51891"><div class="ttname"><a href="fs__dev_8h.html#a4b793945795e850a589fbb9b70b51891">fsdevMountCacheStorage</a></div><div class="ttdeci">Result fsdevMountCacheStorage(const char *name, u64 application_id, u16 save_data_index)</div><div class="ttdoc">Mounts the specified CacheStorage.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a4ba58c9994c656c5feecc78ce84c2656"><div class="ttname"><a href="fs__dev_8h.html#a4ba58c9994c656c5feecc78ce84c2656">fsdevMountSystemSaveData</a></div><div class="ttdeci">Result fsdevMountSystemSaveData(const char *name, FsSaveDataSpaceId save_data_space_id, u64 system_save_data_id, AccountUid uid)</div><div class="ttdoc">Mounts the specified SystemSaveData.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a4c0501b352109acfdfcd65636bfaee16"><div class="ttname"><a href="fs__dev_8h.html#a4c0501b352109acfdfcd65636bfaee16">fsdevMountBcatSaveData</a></div><div class="ttdeci">Result fsdevMountBcatSaveData(const char *name, u64 application_id)</div><div class="ttdoc">Mounts the specified BcatSaveData.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a57244b19f36077b91ce22f019dbcc941"><div class="ttname"><a href="fs__dev_8h.html#a57244b19f36077b91ce22f019dbcc941">fsdevGetLastResult</a></div><div class="ttdeci">Result fsdevGetLastResult(void)</div><div class="ttdoc">Retrieves the last native result code generated during a failed fsdev operation.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a5cbc1f6539fba9280dd09e5ad2fefbd7"><div class="ttname"><a href="fs__dev_8h.html#a5cbc1f6539fba9280dd09e5ad2fefbd7">fsdevGetDeviceFileSystem</a></div><div class="ttdeci">FsFileSystem * fsdevGetDeviceFileSystem(const char *name)</div><div class="ttdoc">Returns the FsFileSystem for the specified device. Returns NULL when the specified device isn't found...</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a68b5d4d1ae75a896cee80dbf941f1008"><div class="ttname"><a href="fs__dev_8h.html#a68b5d4d1ae75a896cee80dbf941f1008">fsdevCreateFile</a></div><div class="ttdeci">Result fsdevCreateFile(const char *path, size_t size, u32 flags)</div><div class="ttdoc">This calls fsFsCreateFile on the filesystem specified by the input path (as used in stdio).</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a74b5f3323ca7a4b4cef5afc216fef092"><div class="ttname"><a href="fs__dev_8h.html#a74b5f3323ca7a4b4cef5afc216fef092">fsdevSetConcatenationFileAttribute</a></div><div class="ttdeci">Result fsdevSetConcatenationFileAttribute(const char *path)</div><div class="ttdoc">This calls fsFsSetConcatenationFileAttribute on the filesystem specified by the input path (as used i...</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a8ed81cedbe85fc0526584a675870bfb0"><div class="ttname"><a href="fs__dev_8h.html#a8ed81cedbe85fc0526584a675870bfb0">fsdevMountDeviceSaveData</a></div><div class="ttdeci">Result fsdevMountDeviceSaveData(const char *name, u64 application_id)</div><div class="ttdoc">Mounts the specified DeviceSaveData.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a96949c9646025f0eadda87ca74532bcd"><div class="ttname"><a href="fs__dev_8h.html#a96949c9646025f0eadda87ca74532bcd">fsdevDirGetEntries</a></div><div class="ttdeci">static FsDirectoryEntry * fsdevDirGetEntries(fsdev_dir_t *dir)</div><div class="ttdoc">Retrieves a pointer to temporary stage for reading entries.</div><div class="ttdef"><b>Definition</b> fs_dev.h:25</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_a9e65c89226ab22ed62eb9776896ede2f"><div class="ttname"><a href="fs__dev_8h.html#a9e65c89226ab22ed62eb9776896ede2f">fsdevMountDevice</a></div><div class="ttdeci">int fsdevMountDevice(const char *name, FsFileSystem fs)</div><div class="ttdoc">Mounts the input fs with the specified device name.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_aa9634b8f9ff2c8e3ad90e6f8e2906a14"><div class="ttname"><a href="fs__dev_8h.html#aa9634b8f9ff2c8e3ad90e6f8e2906a14">fsdevCommitDevice</a></div><div class="ttdeci">Result fsdevCommitDevice(const char *name)</div><div class="ttdoc">Uses fsFsCommit() with the specified device.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_ac1b778fe6a4634dbdb3ad36faf627ed0"><div class="ttname"><a href="fs__dev_8h.html#ac1b778fe6a4634dbdb3ad36faf627ed0">fsdevMountSaveData</a></div><div class="ttdeci">Result fsdevMountSaveData(const char *name, u64 application_id, AccountUid uid)</div><div class="ttdoc">Mounts the specified SaveData.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_ad13800ff0e52530283b410ed3ec03d3c"><div class="ttname"><a href="fs__dev_8h.html#ad13800ff0e52530283b410ed3ec03d3c">fsdevUnmountAll</a></div><div class="ttdeci">Result fsdevUnmountAll(void)</div><div class="ttdoc">Unmounts all devices and cleans up any resources used by the FS driver.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_ad5bd2af2a4d2a011f431bf2c0d1679f2"><div class="ttname"><a href="fs__dev_8h.html#ad5bd2af2a4d2a011f431bf2c0d1679f2">fsdevUnmountDevice</a></div><div class="ttdeci">int fsdevUnmountDevice(const char *name)</div><div class="ttdoc">Unmounts the specified device.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_adbb4e3052a264aac8de47b53f3e41327"><div class="ttname"><a href="fs__dev_8h.html#adbb4e3052a264aac8de47b53f3e41327">fsdevMountSdmc</a></div><div class="ttdeci">Result fsdevMountSdmc(void)</div><div class="ttdoc">Initializes and mounts the sdmc device if accessible.</div></div>
|
|
<div class="ttc" id="afs__dev_8h_html_ae8143f14b60430787055c1c031758a63"><div class="ttname"><a href="fs__dev_8h.html#ae8143f14b60430787055c1c031758a63">fsdevMountSystemBcatSaveData</a></div><div class="ttdeci">Result fsdevMountSystemBcatSaveData(const char *name, u64 system_save_data_id)</div><div class="ttdoc">Mounts the specified SystemBcatSaveData.</div></div>
|
|
<div class="ttc" id="astructAccountUid_html"><div class="ttname"><a href="structAccountUid.html">AccountUid</a></div><div class="ttdoc">Account UserId.</div><div class="ttdef"><b>Definition</b> acc.h:25</div></div>
|
|
<div class="ttc" id="astructFsDir_html"><div class="ttname"><a href="structFsDir.html">FsDir</a></div><div class="ttdef"><b>Definition</b> fs.h:35</div></div>
|
|
<div class="ttc" id="astructFsDirectoryEntry_html"><div class="ttname"><a href="structFsDirectoryEntry.html">FsDirectoryEntry</a></div><div class="ttdoc">Directory entry.</div><div class="ttdef"><b>Definition</b> fs.h:56</div></div>
|
|
<div class="ttc" id="astructFsFileSystem_html"><div class="ttname"><a href="structFsFileSystem.html">FsFileSystem</a></div><div class="ttdef"><b>Definition</b> fs.h:27</div></div>
|
|
<div class="ttc" id="astructfsdev__dir__t_html"><div class="ttname"><a href="structfsdev__dir__t.html">fsdev_dir_t</a></div><div class="ttdoc">Open directory struct.</div><div class="ttdef"><b>Definition</b> fs_dev.h:17</div></div>
|
|
<div class="ttc" id="astructfsdev__dir__t_html_a2b6a04ec1a69f845865a00d461611aa3"><div class="ttname"><a href="structfsdev__dir__t.html#a2b6a04ec1a69f845865a00d461611aa3">fsdev_dir_t::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Current batch size.</div><div class="ttdef"><b>Definition</b> fs_dev.h:21</div></div>
|
|
<div class="ttc" id="astructfsdev__dir__t_html_a5fcbe07d06351a9efcfa2ce4e762af16"><div class="ttname"><a href="structfsdev__dir__t.html#a5fcbe07d06351a9efcfa2ce4e762af16">fsdev_dir_t::magic</a></div><div class="ttdeci">u32 magic</div><div class="ttdoc">"fsdv"</div><div class="ttdef"><b>Definition</b> fs_dev.h:18</div></div>
|
|
<div class="ttc" id="astructfsdev__dir__t_html_a644adafed15480977127f5e4b222550c"><div class="ttname"><a href="structfsdev__dir__t.html#a644adafed15480977127f5e4b222550c">fsdev_dir_t::fd</a></div><div class="ttdeci">FsDir fd</div><div class="ttdoc">File descriptor.</div><div class="ttdef"><b>Definition</b> fs_dev.h:19</div></div>
|
|
<div class="ttc" id="astructfsdev__dir__t_html_af603e154cdaaa7b6c3d3cd233cf1e914"><div class="ttname"><a href="structfsdev__dir__t.html#af603e154cdaaa7b6c3d3cd233cf1e914">fsdev_dir_t::index</a></div><div class="ttdeci">ssize_t index</div><div class="ttdoc">Current entry index.</div><div class="ttdef"><b>Definition</b> fs_dev.h:20</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:22</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ace9d960e74685e2cd84b36132dbbf8aa"><div class="ttname"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a></div><div class="ttdeci">uint16_t u16</div><div class="ttdoc">16-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:20</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ae2a0903442f062ed4f9f0568a6f1a297"><div class="ttname"><a href="types_8h.html#ae2a0903442f062ed4f9f0568a6f1a297">NX_CONSTEXPR</a></div><div class="ttdeci">#define NX_CONSTEXPR</div><div class="ttdoc">Flags a function as constexpr in C++14 and above; or as (always) inline otherwise.</div><div class="ttdef"><b>Definition</b> types.h:92</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:21</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.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|