<!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: C:/Dev/git/UbixOS/sys/include/net/apps/fs.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="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&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  <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&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&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&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('net_2apps_2fs_8h.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="#nested-classes">Data Structures</a> | <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">fs.h File Reference</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><code>#include "<a class="el" href="httpd__opts_8h_source.html">httpd_opts.h</a>"</code><br /> <code>#include "lwip/err.h"</code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for fs.h:</div> <div class="dyncontent"> <div class="center"><img src="net_2apps_2fs_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2apps_2fs_8h" alt=""/></div> </div> </div> <p><a href="net_2apps_2fs_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfs__file.html">fs_file</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a7e36694e0257a7642d41ffda5bf03634"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_2apps_2fs_8h.html#a7e36694e0257a7642d41ffda5bf03634">FS_FILE_FLAGS_HEADER_INCLUDED</a>   0x01</td></tr> <tr class="separator:a7e36694e0257a7642d41ffda5bf03634"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a95e84b4ba432cf58a59f14ba85733584"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_2apps_2fs_8h.html#a95e84b4ba432cf58a59f14ba85733584">FS_FILE_FLAGS_HEADER_PERSISTENT</a>   0x02</td></tr> <tr class="separator:a95e84b4ba432cf58a59f14ba85733584"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3f90d15249e0bc12ed287140356f71dc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_2apps_2fs_8h.html#a3f90d15249e0bc12ed287140356f71dc">FS_READ_DELAYED</a>   -2</td></tr> <tr class="separator:a3f90d15249e0bc12ed287140356f71dc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a05d23b3c867c1f9d701efa0d6d0db92d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_2apps_2fs_8h.html#a05d23b3c867c1f9d701efa0d6d0db92d">FS_READ_EOF</a>   -1</td></tr> <tr class="separator:a05d23b3c867c1f9d701efa0d6d0db92d"><td class="memSeparator" colspan="2"> </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:a3a7ab7c6c0ddd559030d8e91d94ea02b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_2apps_2fs_8h.html#a3a7ab7c6c0ddd559030d8e91d94ea02b">fs_bytes_left</a> (struct <a class="el" href="structfs__file.html">fs_file</a> *<a class="el" href="structfile.html">file</a>)</td></tr> <tr class="separator:a3a7ab7c6c0ddd559030d8e91d94ea02b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a742b1911f18d0c780436b7a6abb08c70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="net_2apps_2fs_8h.html#a742b1911f18d0c780436b7a6abb08c70">fs_close</a> (struct <a class="el" href="structfs__file.html">fs_file</a> *<a class="el" href="structfile.html">file</a>)</td></tr> <tr class="separator:a742b1911f18d0c780436b7a6abb08c70"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a594058d3f4dd9f333c51b7e5ca910ac3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="net_2apps_2fs_8h.html#a594058d3f4dd9f333c51b7e5ca910ac3">fs_open</a> (struct <a class="el" href="structfs__file.html">fs_file</a> *<a class="el" href="structfile.html">file</a>, <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char *<a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)</td></tr> <tr class="separator:a594058d3f4dd9f333c51b7e5ca910ac3"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Macro Definition Documentation</h2> <a id="a7e36694e0257a7642d41ffda5bf03634"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7e36694e0257a7642d41ffda5bf03634">◆ </a></span>FS_FILE_FLAGS_HEADER_INCLUDED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FS_FILE_FLAGS_HEADER_INCLUDED   0x01</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="net_2apps_2fs_8h_source.html#l00053">53</a> of file <a class="el" href="net_2apps_2fs_8h_source.html">fs.h</a>.</p> </div> </div> <a id="a95e84b4ba432cf58a59f14ba85733584"></a> <h2 class="memtitle"><span class="permalink"><a href="#a95e84b4ba432cf58a59f14ba85733584">◆ </a></span>FS_FILE_FLAGS_HEADER_PERSISTENT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FS_FILE_FLAGS_HEADER_PERSISTENT   0x02</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="net_2apps_2fs_8h_source.html#l00054">54</a> of file <a class="el" href="net_2apps_2fs_8h_source.html">fs.h</a>.</p> </div> </div> <a id="a3f90d15249e0bc12ed287140356f71dc"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3f90d15249e0bc12ed287140356f71dc">◆ </a></span>FS_READ_DELAYED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FS_READ_DELAYED   -2</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="net_2apps_2fs_8h_source.html#l00043">43</a> of file <a class="el" href="net_2apps_2fs_8h_source.html">fs.h</a>.</p> </div> </div> <a id="a05d23b3c867c1f9d701efa0d6d0db92d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a05d23b3c867c1f9d701efa0d6d0db92d">◆ </a></span>FS_READ_EOF</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define FS_READ_EOF   -1</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="net_2apps_2fs_8h_source.html#l00042">42</a> of file <a class="el" href="net_2apps_2fs_8h_source.html">fs.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="a3a7ab7c6c0ddd559030d8e91d94ea02b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3a7ab7c6c0ddd559030d8e91d94ea02b">◆ </a></span>fs_bytes_left()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int fs_bytes_left </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structfs__file.html">fs_file</a> * </td> <td class="paramname"><em>file</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="a742b1911f18d0c780436b7a6abb08c70"></a> <h2 class="memtitle"><span class="permalink"><a href="#a742b1911f18d0c780436b7a6abb08c70">◆ </a></span>fs_close()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fs_close </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structfs__file.html">fs_file</a> * </td> <td class="paramname"><em>file</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="a594058d3f4dd9f333c51b7e5ca910ac3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a594058d3f4dd9f333c51b7e5ca910ac3">◆ </a></span>fs_open()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> fs_open </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structfs__file.html">fs_file</a> * </td> <td class="paramname"><em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td> <td class="paramname"><em>name</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> </div> </div> </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="dir_e6bb53534ac0e427887cf7a94c0c004e.html">C:</a></li><li class="navelem"><a class="el" href="dir_d99d5d4662bf24521eef49da6a8cd34d.html">Dev</a></li><li class="navelem"><a class="el" href="dir_474a4b306371cf7e7f6fa12cb0b77df6.html">git</a></li><li class="navelem"><a class="el" href="dir_849109bbd106d461b128d63e5babcedf.html">UbixOS</a></li><li class="navelem"><a class="el" href="dir_6ec99f6d7d5182ba8913209ab70c9f18.html">sys</a></li><li class="navelem"><a class="el" href="dir_d1be8160e739b6eed1f7843efdbae1b3.html">include</a></li><li class="navelem"><a class="el" href="dir_8a452844cab5a537277ef786999bc939.html">net</a></li><li class="navelem"><a class="el" href="dir_21e12f15c353f338a385e10009a09aca.html">apps</a></li><li class="navelem"><a class="el" href="net_2apps_2fs_8h.html">fs.h</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>