Files
discoverpixy/group__filesystem.html
2015-06-08 01:16:45 +02:00

584 lines
38 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.9.1"/>
<title>discoverpixy: Filesystem</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Filesystem</div> </div>
</div><!--header-->
<div class="contents">
<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="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html">FILE_DATE_STRUCT</a></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="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html">FILE_TIME_STRUCT</a></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="struct_f_i_l_e___s_t_r_u_c_t.html">FILE_STRUCT</a></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="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a></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="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a></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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga07e357318d9528f9d2df7e5c86c81a3b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga07e357318d9528f9d2df7e5c86c81a3b">FILE_ATTRIBUTES</a> { <br />
&#160;&#160;<a class="el" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba56340dd998fe228468cb60406dc3f5df">F_RDO</a> =0x01,
<a class="el" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3baa87f9e9b73e66d81563fe63aba76cc7d">F_HID</a> =0x02,
<a class="el" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba4a52b8103f1c46e28720230e62cc18f0">F_SYS</a> =0x04,
<a class="el" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba9d0e592d6c03a8ea881767c87935c790">F_DIR</a> =0x10,
<br />
&#160;&#160;<a class="el" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba68f4a0b4d65d116a6fe51978a608b79a">F_ARC</a> =0x20
<br />
}</td></tr>
<tr class="separator:ga07e357318d9528f9d2df7e5c86c81a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab08f51089a5ddbb470a1a36a9478dda4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> { <br />
&#160;&#160;<a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd">F_OK</a>,
<a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd">F_EOF</a>,
<a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a9400b97001c749e444d41e25dc8ed3f1">F_EACCESS</a>,
<a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ac13e1c44708fd21c9c5a4cdb8b53b472">F_INVALIDPARAM</a>,
<br />
&#160;&#160;<a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a2c5f1702bc6bd15c92158e47061d945a">F_DISKERROR</a>
<br />
}</td></tr>
<tr class="separator:gab08f51089a5ddbb470a1a36a9478dda4"><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:ga367ec5e73c77ddf5047d05021cf97a8f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f">filesystem_init</a> ()</td></tr>
<tr class="separator:ga367ec5e73c77ddf5047d05021cf97a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b1099cbd3464fbe64f2010f16d87101"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga8b1099cbd3464fbe64f2010f16d87101">filesystem_dir_open</a> (const char *path)</td></tr>
<tr class="separator:ga8b1099cbd3464fbe64f2010f16d87101"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab8001e040f37dc57b18e4155532b59ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gab8001e040f37dc57b18e4155532b59ce">filesystem_dir_close</a> (<a class="el" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a> *dir)</td></tr>
<tr class="separator:gab8001e040f37dc57b18e4155532b59ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd043128e80a4f0573b1360d921b046c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open</a> (const char *filename)</td></tr>
<tr class="separator:gabd043128e80a4f0573b1360d921b046c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0e6cc31bf4c889249e13254306994c2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga0e6cc31bf4c889249e13254306994c2f">filesystem_file_close</a> (<a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *handle)</td></tr>
<tr class="separator:ga0e6cc31bf4c889249e13254306994c2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac447af479c334caa207d6c279571d8a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gac447af479c334caa207d6c279571d8a2">filesystem_file_seek</a> (<a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *handle, uint32_t offset)</td></tr>
<tr class="separator:gac447af479c334caa207d6c279571d8a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e7f715d0000e7b99e2b4732416a0221"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga9e7f715d0000e7b99e2b4732416a0221">filesystem_file_read</a> (<a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *handle, uint8_t *buf, uint32_t size)</td></tr>
<tr class="separator:ga9e7f715d0000e7b99e2b4732416a0221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7124857f3ab32f6032ef129f2a80000"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gae7124857f3ab32f6032ef129f2a80000">filesystem_file_write</a> (<a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *handle, uint8_t *buf, uint32_t size)</td></tr>
<tr class="separator:gae7124857f3ab32f6032ef129f2a80000"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The Filesystem Module provides access to files and directories of a the native filesystem. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga07e357318d9528f9d2df7e5c86c81a3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__filesystem.html#ga07e357318d9528f9d2df7e5c86c81a3b">FILE_ATTRIBUTES</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>File Attributes used by implementation See <a href="http://en.wikipedia.org/wiki/Design_of_the_FAT_file_system#attributes">http://en.wikipedia.org/wiki/Design_of_the_FAT_file_system#attributes</a> for detailed description </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga07e357318d9528f9d2df7e5c86c81a3ba56340dd998fe228468cb60406dc3f5df"></a>F_RDO&#160;</td><td class="fielddoc">
<p>File is readonly. You cannot write to it. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga07e357318d9528f9d2df7e5c86c81a3baa87f9e9b73e66d81563fe63aba76cc7d"></a>F_HID&#160;</td><td class="fielddoc">
<p>File is hidden. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga07e357318d9528f9d2df7e5c86c81a3ba4a52b8103f1c46e28720230e62cc18f0"></a>F_SYS&#160;</td><td class="fielddoc">
<p>File is a system file. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga07e357318d9528f9d2df7e5c86c81a3ba9d0e592d6c03a8ea881767c87935c790"></a>F_DIR&#160;</td><td class="fielddoc">
<p>It's a directory and not a file. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga07e357318d9528f9d2df7e5c86c81a3ba68f4a0b4d65d116a6fe51978a608b79a"></a>F_ARC&#160;</td><td class="fielddoc">
<p>File has the archive flag set (probably unused) </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="gab08f51089a5ddbb470a1a36a9478dda4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum to represent the success or error-code of the filesystem_file_* functions </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd"></a>F_OK&#160;</td><td class="fielddoc">
<p>Everything ok. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd"></a>F_EOF&#160;</td><td class="fielddoc">
<p>The write/read operation tried to write/read past the end of the file. This is not a fatal error. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggab08f51089a5ddbb470a1a36a9478dda4a9400b97001c749e444d41e25dc8ed3f1"></a>F_EACCESS&#160;</td><td class="fielddoc">
<p>The file can not be read/written due to access problems. This is a fatal error. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggab08f51089a5ddbb470a1a36a9478dda4ac13e1c44708fd21c9c5a4cdb8b53b472"></a>F_INVALIDPARAM&#160;</td><td class="fielddoc">
<p>You passed invalid parameters to the function. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggab08f51089a5ddbb470a1a36a9478dda4a2c5f1702bc6bd15c92158e47061d945a"></a>F_DISKERROR&#160;</td><td class="fielddoc">
<p>A lowlevel disk-error occoured. This is a fatal error. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab8001e040f37dc57b18e4155532b59ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void filesystem_dir_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a> *&#160;</td>
<td class="paramname"><em>dir</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes a previously opened directory. Free's all allocated resources. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dir</td><td>A Pointer to a <a class="el" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a> obtained by <a class="el" href="group__filesystem.html#ga8b1099cbd3464fbe64f2010f16d87101">filesystem_dir_open()</a>. </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gab8001e040f37dc57b18e4155532b59ce_cgraph.png" border="0" usemap="#group__filesystem_gab8001e040f37dc57b18e4155532b59ce_cgraph" alt=""/></div>
<map name="group__filesystem_gab8001e040f37dc57b18e4155532b59ce_cgraph" id="group__filesystem_gab8001e040f37dc57b18e4155532b59ce_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#ga43292876112535a7cf9bb26201ed8096" title="ll_filesystem_dir_close" alt="" coords="193,5,347,32"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gab8001e040f37dc57b18e4155532b59ce_icgraph.png" border="0" usemap="#group__filesystem_gab8001e040f37dc57b18e4155532b59ce_icgraph" alt=""/></div>
<map name="group__filesystem_gab8001e040f37dc57b18e4155532b59ce_icgraph" id="group__filesystem_gab8001e040f37dc57b18e4155532b59ce_icgraph">
<area shape="rect" id="node2" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="199,5,249,32"/><area shape="rect" id="node3" href="screen__photomode__save_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="193,56,255,83"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga8b1099cbd3464fbe64f2010f16d87101"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a>* filesystem_dir_open </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a directory and returns a structure which contains all files/subdirectories. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__filesystem.html#gab8001e040f37dc57b18e4155532b59ce">filesystem_dir_close()</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The absolute path to the directory to open/read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Pointer to an initialized <a class="el" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a> on success, NULL on error </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_cgraph.png" border="0" usemap="#group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_cgraph" alt=""/></div>
<map name="group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_cgraph" id="group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#ga572cb127d4e8affa9701d8562397389e" title="ll_filesystem_dir_open" alt="" coords="191,5,341,32"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_icgraph.png" border="0" usemap="#group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_icgraph" alt=""/></div>
<map name="group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_icgraph" id="group__filesystem_ga8b1099cbd3464fbe64f2010f16d87101_icgraph">
<area shape="rect" id="node2" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="196,5,247,32"/><area shape="rect" id="node3" href="screen__photomode__save_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="191,56,252,83"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga0e6cc31bf4c889249e13254306994c2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void filesystem_file_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *&#160;</td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes a file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The <a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> obtained by <a class="el" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open()</a> </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_cgraph.png" border="0" usemap="#group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_cgraph" alt=""/></div>
<map name="group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_cgraph" id="group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#ga847113d1c2bffa87807991e2c047bd17" title="ll_filesystem_file\l_close" alt="" coords="196,5,313,47"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_icgraph.png" border="0" usemap="#group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_icgraph" alt=""/></div>
<map name="group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_icgraph" id="group__filesystem_ga0e6cc31bf4c889249e13254306994c2f_icgraph">
<area shape="rect" id="node2" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="515,5,565,32"/><area shape="rect" id="node3" href="screen__photomode__save_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="233,28,295,55"/><area shape="rect" id="node4" href="group__tft.html#gab2955e780414d138b9f90dc6a533b6b8" title="tft_draw_bitmap_file\l_unscaled" alt="" coords="196,79,332,121"/><area shape="rect" id="node5" href="screen__filetest_8c.html#a54566a598cf7f2c507254c62a9d70223" title="image_test" alt="" coords="380,32,467,59"/><area shape="rect" id="node6" href="screen__main_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="398,87,449,113"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="gabd043128e80a4f0573b1360d921b046c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* filesystem_file_open </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a file for read/writing. </p><dl class="section note"><dt>Note</dt><dd>Depending on the implementation you may only open one file at a time </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The absolute file path </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Pointer to a <a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> on success, NULL on error. </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gabd043128e80a4f0573b1360d921b046c_cgraph.png" border="0" usemap="#group__filesystem_gabd043128e80a4f0573b1360d921b046c_cgraph" alt=""/></div>
<map name="group__filesystem_gabd043128e80a4f0573b1360d921b046c_cgraph" id="group__filesystem_gabd043128e80a4f0573b1360d921b046c_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#ga61e4a1cdb3435031c3a9df014ab21d08" title="ll_filesystem_file_open" alt="" coords="192,5,344,32"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gabd043128e80a4f0573b1360d921b046c_icgraph.png" border="0" usemap="#group__filesystem_gabd043128e80a4f0573b1360d921b046c_icgraph" alt=""/></div>
<map name="group__filesystem_gabd043128e80a4f0573b1360d921b046c_icgraph" id="group__filesystem_gabd043128e80a4f0573b1360d921b046c_icgraph">
<area shape="rect" id="node2" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="511,5,561,32"/><area shape="rect" id="node3" href="screen__photomode__save_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="229,28,291,55"/><area shape="rect" id="node4" href="group__tft.html#gab2955e780414d138b9f90dc6a533b6b8" title="tft_draw_bitmap_file\l_unscaled" alt="" coords="192,79,328,121"/><area shape="rect" id="node5" href="screen__filetest_8c.html#a54566a598cf7f2c507254c62a9d70223" title="image_test" alt="" coords="376,32,463,59"/><area shape="rect" id="node6" href="screen__main_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="394,87,445,113"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga9e7f715d0000e7b99e2b4732416a0221"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> filesystem_file_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads some bytes from an open file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The <a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> obtained by <a class="el" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open()</a> </td></tr>
<tr><td class="paramname">buf</td><td>The Buffer to write the bytes to </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd">F_OK</a> on success, <a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd">F_EOF</a> if less than <code>size</code> bytes could be read, an error Code otherwise. </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_cgraph.png" border="0" usemap="#group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_cgraph" alt=""/></div>
<map name="group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_cgraph" id="group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#ga8826f1d0e79cc734ea38315e5516f109" title="ll_filesystem_file_read" alt="" coords="189,5,339,32"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_icgraph.png" border="0" usemap="#group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_icgraph" alt=""/></div>
<map name="group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_icgraph" id="group__filesystem_ga9e7f715d0000e7b99e2b4732416a0221_icgraph">
<area shape="rect" id="node2" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="508,5,559,32"/><area shape="rect" id="node3" href="group__tft.html#gab2955e780414d138b9f90dc6a533b6b8" title="tft_draw_bitmap_file\l_unscaled" alt="" coords="189,31,325,73"/><area shape="rect" id="node4" href="screen__filetest_8c.html#a54566a598cf7f2c507254c62a9d70223" title="image_test" alt="" coords="373,31,460,57"/><area shape="rect" id="node5" href="screen__main_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="391,81,442,108"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="gac447af479c334caa207d6c279571d8a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> filesystem_file_seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set's the read/write position to a new position </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The <a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> obtained by <a class="el" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open()</a> </td></tr>
<tr><td class="paramname">offset</td><td>The new read/write position in bytes (absolute). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd">F_OK</a> on success, an error Code otherwise. </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gac447af479c334caa207d6c279571d8a2_cgraph.png" border="0" usemap="#group__filesystem_gac447af479c334caa207d6c279571d8a2_cgraph" alt=""/></div>
<map name="group__filesystem_gac447af479c334caa207d6c279571d8a2_cgraph" id="group__filesystem_gac447af479c334caa207d6c279571d8a2_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#ga27b21c519c928bc7767fbdcbb9209148" title="ll_filesystem_file_seek" alt="" coords="192,5,344,32"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gac447af479c334caa207d6c279571d8a2_icgraph.png" border="0" usemap="#group__filesystem_gac447af479c334caa207d6c279571d8a2_icgraph" alt=""/></div>
<map name="group__filesystem_gac447af479c334caa207d6c279571d8a2_icgraph" id="group__filesystem_gac447af479c334caa207d6c279571d8a2_icgraph">
<area shape="rect" id="node2" href="pixy__frame_8c.html#a9b12014ced2f09e5e7d6646b966552ef" title="saveBA81" alt="" coords="220,5,300,32"/><area shape="rect" id="node5" href="screen__photomode__save_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="784,31,845,57"/><area shape="rect" id="node6" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="640,132,691,159"/><area shape="rect" id="node7" href="group__tft.html#gab2955e780414d138b9f90dc6a533b6b8" title="tft_draw_bitmap_file\l_unscaled" alt="" coords="192,158,328,199"/><area shape="rect" id="node3" href="group__pixy__helper.html#gaf0820ad9bb1ae6791fecb3916372c479" title="pixy_save_cropped_frame" alt="" coords="376,5,547,32"/><area shape="rect" id="node4" href="group__pixy__helper.html#gaeb47b641ad8f8cb10c26debb27c7dead" title="pixy_save_full_frame" alt="" coords="595,5,736,32"/><area shape="rect" id="node8" href="screen__filetest_8c.html#a54566a598cf7f2c507254c62a9d70223" title="image_test" alt="" coords="418,157,505,184"/><area shape="rect" id="node9" href="screen__main_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="436,208,487,235"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="gae7124857f3ab32f6032ef129f2a80000"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> filesystem_file_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> *&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes some bytes to a open file. </p><dl class="section note"><dt>Note</dt><dd>Depending on the implementation the file may not be shrinked or expanded. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The <a class="el" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a> obtained by <a class="el" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open()</a> </td></tr>
<tr><td class="paramname">buf</td><td>The Buffer to take the bytes from </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd">F_OK</a> on success, <a class="el" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd">F_EOF</a> if less than <code>size</code> bytes could be written, an error Code otherwise. </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gae7124857f3ab32f6032ef129f2a80000_cgraph.png" border="0" usemap="#group__filesystem_gae7124857f3ab32f6032ef129f2a80000_cgraph" alt=""/></div>
<map name="group__filesystem_gae7124857f3ab32f6032ef129f2a80000_cgraph" id="group__filesystem_gae7124857f3ab32f6032ef129f2a80000_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#gab7ce3131ebbf7c556c9ebeea312fce02" title="ll_filesystem_file\l_write" alt="" coords="192,5,309,47"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_gae7124857f3ab32f6032ef129f2a80000_icgraph.png" border="0" usemap="#group__filesystem_gae7124857f3ab32f6032ef129f2a80000_icgraph" alt=""/></div>
<map name="group__filesystem_gae7124857f3ab32f6032ef129f2a80000_icgraph" id="group__filesystem_gae7124857f3ab32f6032ef129f2a80000_icgraph">
<area shape="rect" id="node2" href="pixy__frame_8c.html#a9b12014ced2f09e5e7d6646b966552ef" title="saveBA81" alt="" coords="192,5,272,32"/><area shape="rect" id="node5" href="screen__photomode__save_8c.html#a5e8f84ee8ff4bf827775c38ae6752509" title="update" alt="" coords="728,31,789,57"/><area shape="rect" id="node6" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="207,107,257,133"/><area shape="rect" id="node3" href="group__pixy__helper.html#gaf0820ad9bb1ae6791fecb3916372c479" title="pixy_save_cropped_frame" alt="" coords="320,5,491,32"/><area shape="rect" id="node4" href="group__pixy__helper.html#gaeb47b641ad8f8cb10c26debb27c7dead" title="pixy_save_full_frame" alt="" coords="539,5,680,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga367ec5e73c77ddf5047d05021cf97a8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool filesystem_init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the filesystem. Call this method before using any filesystem_* functions </p><dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_cgraph.png" border="0" usemap="#group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_cgraph" alt=""/></div>
<map name="group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_cgraph" id="group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_cgraph">
<area shape="rect" id="node2" href="group__ll__filesystem.html#ga5e9b54813d51bd15dff031285911a95e" title="ll_filesystem_init" alt="" coords="159,5,277,32"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_icgraph.png" border="0" usemap="#group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_icgraph" alt=""/></div>
<map name="group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_icgraph" id="group__filesystem_ga367ec5e73c77ddf5047d05021cf97a8f_icgraph">
<area shape="rect" id="node2" href="group__app.html#ga8c6e58bb7e2a0dcf8537fc940ebfa385" title="app_init" alt="" coords="159,5,225,32"/></map>
</div>
</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 8 2015 01:15:03 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>