Newer
Older
UbixOS / doc / html / structfileSystem.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.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS V2: fileSystem Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</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">UbixOS V2
   &#160;<span id="projectnumber">2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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');
/* @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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structfileSystem.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">fileSystem Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>filesSystem Structure  
 <a href="structfileSystem.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for fileSystem:</div>
<div class="dyncontent">
<div class="center"><img src="structfileSystem__coll__graph.png" border="0" usemap="#fileSystem_coll__map" alt="Collaboration graph"/></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa53ac2dce5c23d729ca2e49907a542de"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structfileSystem.html">fileSystem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#aa53ac2dce5c23d729ca2e49907a542de">next</a></td></tr>
<tr class="separator:aa53ac2dce5c23d729ca2e49907a542de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a385cd52ba55b3ed318ee54f3f42b5a54"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structfileSystem.html">fileSystem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#a385cd52ba55b3ed318ee54f3f42b5a54">prev</a></td></tr>
<tr class="separator:a385cd52ba55b3ed318ee54f3f42b5a54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a162bc57655bb47dbbdc2e1285f08e5"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#a1a162bc57655bb47dbbdc2e1285f08e5">vfsInitFS</a> )(void *)</td></tr>
<tr class="separator:a1a162bc57655bb47dbbdc2e1285f08e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cd903f29e242ecc35938b91d43c4ba5"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#a4cd903f29e242ecc35938b91d43c4ba5">vfsMakeDir</a> )(char *, void *)</td></tr>
<tr class="separator:a4cd903f29e242ecc35938b91d43c4ba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2816f106f39d0355faf5689d92a9b8b"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#af2816f106f39d0355faf5689d92a9b8b">vfsOpenFile</a> )(void *, void *)</td></tr>
<tr class="separator:af2816f106f39d0355faf5689d92a9b8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ae6c56aba90970c49df0fe24d82c864"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#a0ae6c56aba90970c49df0fe24d82c864">vfsRead</a> )(void *, char *, long, long)</td></tr>
<tr class="separator:a0ae6c56aba90970c49df0fe24d82c864"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74c0d3cf3df39d9227bcd98cf73ef6ba"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#a74c0d3cf3df39d9227bcd98cf73ef6ba">vfsRemDir</a> )(char *)</td></tr>
<tr class="separator:a74c0d3cf3df39d9227bcd98cf73ef6ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af66a5069337e4e257e517f6823b9c178"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#af66a5069337e4e257e517f6823b9c178">vfsSync</a> )(void)</td></tr>
<tr class="separator:af66a5069337e4e257e517f6823b9c178"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1b7987f710ba203dffb15590ff58ce0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#aa1b7987f710ba203dffb15590ff58ce0">vfsType</a></td></tr>
<tr class="separator:aa1b7987f710ba203dffb15590ff58ce0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8f269aaf16c2ed5b2171b18a0bee418"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#ad8f269aaf16c2ed5b2171b18a0bee418">vfsUnlink</a> )(char *, void *)</td></tr>
<tr class="separator:ad8f269aaf16c2ed5b2171b18a0bee418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcbc968dbf271d2fbdf1b3e75e5b5685"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html#adcbc968dbf271d2fbdf1b3e75e5b5685">vfsWrite</a> )(void *, char *, long, long)</td></tr>
<tr class="separator:adcbc968dbf271d2fbdf1b3e75e5b5685"><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>filesSystem Structure </p>
<p>not sure if we should allow function to point to NULL </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00059">59</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aa53ac2dce5c23d729ca2e49907a542de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa53ac2dce5c23d729ca2e49907a542de">&#9670;&nbsp;</a></span>next</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structfileSystem.html">fileSystem</a>* fileSystem::next</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00061">61</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="vfs_8c_source.html#l00057">vfsFindFS()</a>.</p>

</div>
</div>
<a id="a385cd52ba55b3ed318ee54f3f42b5a54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a385cd52ba55b3ed318ee54f3f42b5a54">&#9670;&nbsp;</a></span>prev</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structfileSystem.html">fileSystem</a>* fileSystem::prev</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00060">60</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

</div>
</div>
<a id="a1a162bc57655bb47dbbdc2e1285f08e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a162bc57655bb47dbbdc2e1285f08e5">&#9670;&nbsp;</a></span>vfsInitFS</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsInitFS) (void *)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to inialization routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00062">62</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="mount_8c_source.html#l00045">vfs_mount()</a>.</p>

</div>
</div>
<a id="a4cd903f29e242ecc35938b91d43c4ba5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cd903f29e242ecc35938b91d43c4ba5">&#9670;&nbsp;</a></span>vfsMakeDir</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsMakeDir) (char *, void *)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to makedir routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00067">67</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="file_8c_source.html#l00576">sysMkDir()</a>.</p>

</div>
</div>
<a id="af2816f106f39d0355faf5689d92a9b8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2816f106f39d0355faf5689d92a9b8b">&#9670;&nbsp;</a></span>vfsOpenFile</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsOpenFile) (void *, void *)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to openfile routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00065">65</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="file_8c_source.html#l00388">fopen()</a>.</p>

</div>
</div>
<a id="a0ae6c56aba90970c49df0fe24d82c864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ae6c56aba90970c49df0fe24d82c864">&#9670;&nbsp;</a></span>vfsRead</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsRead) (void *, char *, long, long)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to read routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00063">63</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="file_8c_source.html#l00366">fgetc()</a>, and <a class="el" href="file_8c_source.html#l00291">fread()</a>.</p>

</div>
</div>
<a id="a74c0d3cf3df39d9227bcd98cf73ef6ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74c0d3cf3df39d9227bcd98cf73ef6ba">&#9670;&nbsp;</a></span>vfsRemDir</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsRemDir) (char *)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to remdir routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00068">68</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

</div>
</div>
<a id="af66a5069337e4e257e517f6823b9c178"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af66a5069337e4e257e517f6823b9c178">&#9670;&nbsp;</a></span>vfsSync</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsSync) (void)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to sync routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00069">69</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

</div>
</div>
<a id="aa1b7987f710ba203dffb15590ff58ce0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1b7987f710ba203dffb15590ff58ce0">&#9670;&nbsp;</a></span>vfsType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fileSystem::vfsType</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>vfs type id </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00070">70</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="mount_8c_source.html#l00045">vfs_mount()</a>, and <a class="el" href="vfs_8c_source.html#l00057">vfsFindFS()</a>.</p>

</div>
</div>
<a id="ad8f269aaf16c2ed5b2171b18a0bee418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8f269aaf16c2ed5b2171b18a0bee418">&#9670;&nbsp;</a></span>vfsUnlink</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsUnlink) (char *, void *)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to unlink routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00066">66</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

</div>
</div>
<a id="adcbc968dbf271d2fbdf1b3e75e5b5685"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcbc968dbf271d2fbdf1b3e75e5b5685">&#9670;&nbsp;</a></span>vfsWrite</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* fileSystem::vfsWrite) (void *, char *, long, long)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to write routine </p>

<p class="definition">Definition at line <a class="el" href="include_2vfs_2vfs_8h_source.html#l00064">64</a> of file <a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="file_8c_source.html#l00350">fputc()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>C:/Dev/git/UbixOS/sys/include/vfs/<a class="el" href="include_2vfs_2vfs_8h_source.html">vfs.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structfileSystem.html">fileSystem</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
  </ul>
</div>
</body>
</html>