visus
/
teensy-sdfat
關註 1
收藏 0
複製 0
程式碼 問題管理 0 合併請求 0 版本發佈 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
31 Commit
1 分支
目錄樹: 080e24c4d1
分支列表 標籤列表
${ item.name }
Create branch ${ searchTerm }
from '080e24c4d1'
${ noResults }
teensy-sdfat/html/class_fat_file.html

2919 line
134KB
原始文件 Blame 文件歷史 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.10"/>

  7. <title>SdFat: FatFile Class Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/searchdata.js"></script>

  13. <script type="text/javascript" src="search/search.js"></script>

  14. <script type="text/javascript">

  15.   $(document).ready(function() { init_search(); });

  16. </script>

  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  18. </head>

  19. <body>

  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  21. <div id="titlearea">

  22. <table cellspacing="0" cellpadding="0">

  23.  <tbody>

  24.  <tr style="height: 56px;">

  25.   <td id="projectalign" style="padding-left: 0.5em;">

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

  33. <!-- end header part -->

  34. <!-- Generated by Doxygen 1.8.10 -->

  35. <script type="text/javascript">

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  37. </script>

  38.   <div id="navrow1" class="tabs">

  39.     <ul class="tablist">

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  41.       <li><a href="modules.html"><span>Modules</span></a></li>

  42.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  43.       <li><a href="files.html"><span>Files</span></a></li>

  44.       <li>

  45.         <div id="MSearchBox" class="MSearchBoxInactive">

  46.         <span class="left">

  47.           <img id="MSearchSelect" src="search/mag_sel.png"

  48.                onmouseover="return searchBox.OnSearchSelectShow()"

  49.                onmouseout="return searchBox.OnSearchSelectHide()"

  50.                alt=""/>

  51.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  52.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  53.                onblur="searchBox.OnSearchFieldFocus(false)" 

  54.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  55.           </span><span class="right">

  56.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

  62.   <div id="navrow2" class="tabs2">

  63.     <ul class="tablist">

  64.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  65.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. </div>

  75. 

  76. <!-- iframe showing the search results (closed by default) -->

  77. <div id="MSearchResultsWindow">

  78. <iframe src="javascript:void(0)" frameborder="0" 

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

  83. </div><!-- top -->

  84. <div class="header">

  85.   <div class="summary">

  86. <a href="#pub-methods">Public Member Functions</a> &#124;

  87. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;

  88. <a href="class_fat_file-members.html">List of all members</a>  </div>

  89.   <div class="headertitle">

  90. <div class="title">FatFile Class Reference</div>  </div>

  91. </div><!--header-->

  92. <div class="contents">

  93. 

  94. <p>Basic file class.  

  95.  <a href="class_fat_file.html#details">More...</a></p>

  96. 

  97. <p><code>#include &lt;FatFile.h&gt;</code></p>

  98. <div class="dynheader">

  99. Inheritance diagram for FatFile:</div>

  100. <div class="dyncontent">

  101. <div class="center"><img src="class_fat_file__inherit__graph.png" border="0" usemap="#_fat_file_inherit__map" alt="Inheritance graph"/></div>

  102. <map name="_fat_file_inherit__map" id="_fat_file_inherit__map">

  103. <area shape="rect" id="node2" href="class_fat_stream_base.html" title="Base class for C++ style streams. " alt="" coords="72,80,185,107"/>

  104. <area shape="rect" id="node6" href="class_file.html" title="Arduino SD.h style File API. " alt="" coords="210,80,253,107"/>

  105. <area shape="rect" id="node7" href="class_print_file.html" title="FatFile with Print. " alt="" coords="277,80,348,107"/>

  106. <area shape="rect" id="node8" href="class_sd_base_file.html" title="Class for backward compatibility. " alt="" coords="372,80,461,107"/>

  107. <area shape="rect" id="node9" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. " alt="" coords="485,80,580,107"/>

  108. <area shape="rect" id="node3" href="classfstream.html" title="file input/output stream. " alt="" coords="5,155,71,181"/>

  109. <area shape="rect" id="node4" href="classifstream.html" title="file input stream. " alt="" coords="95,155,163,181"/>

  110. <area shape="rect" id="node5" href="classofstream.html" title="file output stream. " alt="" coords="187,155,259,181"/>

  111. </map>

  112. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  113. <table class="memberdecls">

  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  115. Public Member Functions</h2></td></tr>

  116. <tr class="memitem:ac1fa779d98db7ffdb96f8019ab0060d6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac1fa779d98db7ffdb96f8019ab0060d6">available</a> ()</td></tr>

  117. <tr class="separator:ac1fa779d98db7ffdb96f8019ab0060d6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  118. <tr class="memitem:a052e2c15a39b322a5307b693b8835b22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a052e2c15a39b322a5307b693b8835b22">clearError</a> ()</td></tr>

  119. <tr class="separator:a052e2c15a39b322a5307b693b8835b22"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. <tr class="memitem:aeca2a2eff91e6aa55fe1b0e3860c9a05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aeca2a2eff91e6aa55fe1b0e3860c9a05">clearWriteError</a> ()</td></tr>

  121. <tr class="separator:aeca2a2eff91e6aa55fe1b0e3860c9a05"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. <tr class="memitem:afd16af325e0642e4bff6430b7d8bb18b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afd16af325e0642e4bff6430b7d8bb18b">close</a> ()</td></tr>

  123. <tr class="separator:afd16af325e0642e4bff6430b7d8bb18b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  124. <tr class="memitem:aa367708bcc8bc0e0c45c0c2a812c65da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa367708bcc8bc0e0c45c0c2a812c65da">contiguousRange</a> (uint32_t *bgnBlock, uint32_t *endBlock)</td></tr>

  125. <tr class="separator:aa367708bcc8bc0e0c45c0c2a812c65da"><td class="memSeparator" colspan="2">&#160;</td></tr>

  126. <tr class="memitem:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0afc2a1cffa238d1cb2049bfa2d8d199">createContiguous</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, uint32_t size)</td></tr>

  127. <tr class="separator:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. <tr class="memitem:a4c03e2f6729526786e6ab4a623e0339b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4c03e2f6729526786e6ab4a623e0339b">curCluster</a> () const </td></tr>

  129. <tr class="separator:a4c03e2f6729526786e6ab4a623e0339b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  130. <tr class="memitem:a20c55b134bfd1d287a00bf64eba9332e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a20c55b134bfd1d287a00bf64eba9332e">curPosition</a> () const </td></tr>

  131. <tr class="separator:a20c55b134bfd1d287a00bf64eba9332e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <tr class="memitem:a6858d18c807411a071fd6d1b39d50087"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6858d18c807411a071fd6d1b39d50087">dirEntry</a> (<a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir)</td></tr>

  133. <tr class="separator:a6858d18c807411a071fd6d1b39d50087"><td class="memSeparator" colspan="2">&#160;</td></tr>

  134. <tr class="memitem:ae5ec24d4a94d3780384d3f2b731c7eb9"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae5ec24d4a94d3780384d3f2b731c7eb9">dirIndex</a> ()</td></tr>

  135. <tr class="separator:ae5ec24d4a94d3780384d3f2b731c7eb9"><td class="memSeparator" colspan="2">&#160;</td></tr>

  136. <tr class="memitem:ae2ed15f05c9ccbce355e7a8d3ce8382d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae2ed15f05c9ccbce355e7a8d3ce8382d">dirSize</a> ()</td></tr>

  137. <tr class="separator:ae2ed15f05c9ccbce355e7a8d3ce8382d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  138. <tr class="memitem:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4f01d27954ae49aeb6888ac7302f55d9">dmpFile</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint32_t pos, size_t n)</td></tr>

  139. <tr class="separator:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memSeparator" colspan="2">&#160;</td></tr>

  140. <tr class="memitem:a50242f98dea0d4488ce4039a279f2a57"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a50242f98dea0d4488ce4039a279f2a57">exists</a> (const char *path)</td></tr>

  141. <tr class="separator:a50242f98dea0d4488ce4039a279f2a57"><td class="memSeparator" colspan="2">&#160;</td></tr>

  142. <tr class="memitem:a7b591c9b92165fa8e4eae8c30c30e533"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7b591c9b92165fa8e4eae8c30c30e533">FatFile</a> ()</td></tr>

  143. <tr class="separator:a7b591c9b92165fa8e4eae8c30c30e533"><td class="memSeparator" colspan="2">&#160;</td></tr>

  144. <tr class="memitem:a29d31067d0aa3a9a74b1a660c38775cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a29d31067d0aa3a9a74b1a660c38775cc">FatFile</a> (const char *path, uint8_t oflag)</td></tr>

  145. <tr class="separator:a29d31067d0aa3a9a74b1a660c38775cc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  146. <tr class="memitem:a31ef26b3ee37cf5f5f4c6024c0ddab69"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets</a> (char *str, int16_t num, char *delim=0)</td></tr>

  147. <tr class="separator:a31ef26b3ee37cf5f5f4c6024c0ddab69"><td class="memSeparator" colspan="2">&#160;</td></tr>

  148. <tr class="memitem:a7e043dfb89d268bfd620bbbadacf1002"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7e043dfb89d268bfd620bbbadacf1002">fileAttr</a> () const </td></tr>

  149. <tr class="separator:a7e043dfb89d268bfd620bbbadacf1002"><td class="memSeparator" colspan="2">&#160;</td></tr>

  150. <tr class="memitem:a02fc3b3ca36b4745f695f3de8c8ec36d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a02fc3b3ca36b4745f695f3de8c8ec36d">fileSize</a> () const </td></tr>

  151. <tr class="separator:a02fc3b3ca36b4745f695f3de8c8ec36d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  152. <tr class="memitem:a1057bc23b92a074539f661e896e79a09"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a1057bc23b92a074539f661e896e79a09">firstCluster</a> () const </td></tr>

  153. <tr class="separator:a1057bc23b92a074539f661e896e79a09"><td class="memSeparator" colspan="2">&#160;</td></tr>

  154. <tr class="memitem:ad0dbbd083180f44c7a3ce7124d4ce19c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad0dbbd083180f44c7a3ce7124d4ce19c">getError</a> ()</td></tr>

  155. <tr class="separator:ad0dbbd083180f44c7a3ce7124d4ce19c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  156. <tr class="memitem:aafa565e286440aab612cdb430fc01da5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aafa565e286440aab612cdb430fc01da5">getName</a> (char *name, size_t size)</td></tr>

  157. <tr class="separator:aafa565e286440aab612cdb430fc01da5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  158. <tr class="memitem:aaa4f9886887947815a61eaf015996932"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aaa4f9886887947815a61eaf015996932">getpos</a> (<a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *pos)</td></tr>

  159. <tr class="separator:aaa4f9886887947815a61eaf015996932"><td class="memSeparator" colspan="2">&#160;</td></tr>

  160. <tr class="memitem:aba30e92a66f8e0d2f815c85662772a58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aba30e92a66f8e0d2f815c85662772a58">getSFN</a> (char *name)</td></tr>

  161. <tr class="separator:aba30e92a66f8e0d2f815c85662772a58"><td class="memSeparator" colspan="2">&#160;</td></tr>

  162. <tr class="memitem:a8062c0d3a118e8d77d0310418703d5f5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8062c0d3a118e8d77d0310418703d5f5">getWriteError</a> ()</td></tr>

  163. <tr class="separator:a8062c0d3a118e8d77d0310418703d5f5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  164. <tr class="memitem:aef41d65e0f1ce753d18cc9ed691f7de4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aef41d65e0f1ce753d18cc9ed691f7de4">isDir</a> () const </td></tr>

  165. <tr class="separator:aef41d65e0f1ce753d18cc9ed691f7de4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  166. <tr class="memitem:afcf6270ea8d4a3a5f8e89523bc684e22"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afcf6270ea8d4a3a5f8e89523bc684e22">isFile</a> () const </td></tr>

  167. <tr class="separator:afcf6270ea8d4a3a5f8e89523bc684e22"><td class="memSeparator" colspan="2">&#160;</td></tr>

  168. <tr class="memitem:a7eefe7408f34b6326f0c6e78af7eb05f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7eefe7408f34b6326f0c6e78af7eb05f">isHidden</a> () const </td></tr>

  169. <tr class="separator:a7eefe7408f34b6326f0c6e78af7eb05f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  170. <tr class="memitem:aed36d17f8fde597b6ed9446faec1f7e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aed36d17f8fde597b6ed9446faec1f7e3">isLFN</a> () const </td></tr>

  171. <tr class="separator:aed36d17f8fde597b6ed9446faec1f7e3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  172. <tr class="memitem:a4c8a07b081f04aa25839c6f56c739bdc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4c8a07b081f04aa25839c6f56c739bdc">isOpen</a> () const </td></tr>

  173. <tr class="separator:a4c8a07b081f04aa25839c6f56c739bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  174. <tr class="memitem:a6872d3acb1e70f81c9c2be2495977583"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6872d3acb1e70f81c9c2be2495977583">isReadOnly</a> () const </td></tr>

  175. <tr class="separator:a6872d3acb1e70f81c9c2be2495977583"><td class="memSeparator" colspan="2">&#160;</td></tr>

  176. <tr class="memitem:aa4a206803a4bf8243be20244c1aef4d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa4a206803a4bf8243be20244c1aef4d2">isRoot</a> () const </td></tr>

  177. <tr class="separator:aa4a206803a4bf8243be20244c1aef4d2"><td class="memSeparator" colspan="2">&#160;</td></tr>

  178. <tr class="memitem:a1449b294e3a838396c62e47674ca8cf0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a1449b294e3a838396c62e47674ca8cf0">isRoot32</a> () const </td></tr>

  179. <tr class="separator:a1449b294e3a838396c62e47674ca8cf0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  180. <tr class="memitem:a8215bd4b21e11ec83fa88ef226ceb06f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8215bd4b21e11ec83fa88ef226ceb06f">isRootFixed</a> () const </td></tr>

  181. <tr class="separator:a8215bd4b21e11ec83fa88ef226ceb06f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  182. <tr class="memitem:a95b503b17442c2b364a2f53de1b2aeba"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a95b503b17442c2b364a2f53de1b2aeba">isSubDir</a> () const </td></tr>

  183. <tr class="separator:a95b503b17442c2b364a2f53de1b2aeba"><td class="memSeparator" colspan="2">&#160;</td></tr>

  184. <tr class="memitem:add932e13e5bf32ad467af6ec34824e3c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#add932e13e5bf32ad467af6ec34824e3c">isSystem</a> () const </td></tr>

  185. <tr class="separator:add932e13e5bf32ad467af6ec34824e3c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  186. <tr class="memitem:ad49f688a494b351ccbb0102dcfafb925"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad49f688a494b351ccbb0102dcfafb925">ls</a> (uint8_t flags=0)</td></tr>

  187. <tr class="separator:ad49f688a494b351ccbb0102dcfafb925"><td class="memSeparator" colspan="2">&#160;</td></tr>

  188. <tr class="memitem:acabf31ff85e696fbf384c49428012fea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#acabf31ff85e696fbf384c49428012fea">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0, uint8_t indent=0)</td></tr>

  189. <tr class="separator:acabf31ff85e696fbf384c49428012fea"><td class="memSeparator" colspan="2">&#160;</td></tr>

  190. <tr class="memitem:abab5b9f72cc796388dd4eed01d13d90d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abab5b9f72cc796388dd4eed01d13d90d">mkdir</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dir, const char *path, bool pFlag=true)</td></tr>

  191. <tr class="separator:abab5b9f72cc796388dd4eed01d13d90d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  192. <tr class="memitem:a5f64576d3d19177ab3cf3812b69abdfa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open</a> (<a class="el" href="class_fat_file_system.html">FatFileSystem</a> *fs, const char *path, uint8_t oflag)</td></tr>

  193. <tr class="separator:a5f64576d3d19177ab3cf3812b69abdfa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  194. <tr class="memitem:ad3fa9daaccb4e4179fb88a8ca037aa80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad3fa9daaccb4e4179fb88a8ca037aa80">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint16_t index, uint8_t oflag)</td></tr>

  195. <tr class="separator:ad3fa9daaccb4e4179fb88a8ca037aa80"><td class="memSeparator" colspan="2">&#160;</td></tr>

  196. <tr class="memitem:a211be757679b18708f6b6a36464e4f61"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, uint8_t oflag)</td></tr>

  197. <tr class="separator:a211be757679b18708f6b6a36464e4f61"><td class="memSeparator" colspan="2">&#160;</td></tr>

  198. <tr class="memitem:ab0e7075062c89f356441f80fc64d03e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab0e7075062c89f356441f80fc64d03e6">open</a> (const char *path, uint8_t oflag=O_READ)</td></tr>

  199. <tr class="separator:ab0e7075062c89f356441f80fc64d03e6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  200. <tr class="memitem:a8034c4649eb0d26715b1a8a69e73d9d0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8034c4649eb0d26715b1a8a69e73d9d0">openNext</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint8_t oflag=O_READ)</td></tr>

  201. <tr class="separator:a8034c4649eb0d26715b1a8a69e73d9d0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  202. <tr class="memitem:a7e0c0548fed3a69e7284b91b694439d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7e0c0548fed3a69e7284b91b694439d4">openRoot</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol)</td></tr>

  203. <tr class="separator:a7e0c0548fed3a69e7284b91b694439d4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  204. <tr class="memitem:ac05b7136b887539426856c623869aa3a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac05b7136b887539426856c623869aa3a">peek</a> ()</td></tr>

  205. <tr class="separator:ac05b7136b887539426856c623869aa3a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  206. <tr class="memitem:a558530f20314a8d8ee3d1a488fc7f46e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a558530f20314a8d8ee3d1a488fc7f46e">printCreateDateTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

  207. <tr class="separator:a558530f20314a8d8ee3d1a488fc7f46e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  208. <tr class="memitem:a7478cad0f9e5079311b9e1fa558016ff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7478cad0f9e5079311b9e1fa558016ff">printField</a> (float value, char term, uint8_t prec=2)</td></tr>

  209. <tr class="separator:a7478cad0f9e5079311b9e1fa558016ff"><td class="memSeparator" colspan="2">&#160;</td></tr>

  210. <tr class="memitem:abd3e1747511216462b3ef98167156cbb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#abd3e1747511216462b3ef98167156cbb">printField</a> (int16_t value, char term)</td></tr>

  211. <tr class="separator:abd3e1747511216462b3ef98167156cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  212. <tr class="memitem:a9972c2419c293ef9c382bff666b9ae4d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9972c2419c293ef9c382bff666b9ae4d">printField</a> (uint16_t value, char term)</td></tr>

  213. <tr class="separator:a9972c2419c293ef9c382bff666b9ae4d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  214. <tr class="memitem:a41b3b32dd8482429b74c7af3432d6cf8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a41b3b32dd8482429b74c7af3432d6cf8">printField</a> (int32_t value, char term)</td></tr>

  215. <tr class="separator:a41b3b32dd8482429b74c7af3432d6cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  216. <tr class="memitem:a097240f08baadeb1c64b63eab9afb088"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a097240f08baadeb1c64b63eab9afb088">printField</a> (uint32_t value, char term)</td></tr>

  217. <tr class="separator:a097240f08baadeb1c64b63eab9afb088"><td class="memSeparator" colspan="2">&#160;</td></tr>

  218. <tr class="memitem:a12a5d2de2737c201aa39ca1bd2ab9c47"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a12a5d2de2737c201aa39ca1bd2ab9c47">printFileSize</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

  219. <tr class="separator:a12a5d2de2737c201aa39ca1bd2ab9c47"><td class="memSeparator" colspan="2">&#160;</td></tr>

  220. <tr class="memitem:a05cee5df46a370bf916d3ba597c82e39"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a05cee5df46a370bf916d3ba597c82e39">printModifyDateTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

  221. <tr class="separator:a05cee5df46a370bf916d3ba597c82e39"><td class="memSeparator" colspan="2">&#160;</td></tr>

  222. <tr class="memitem:ad1cbc3aeb0f5193b7a26595966da9621"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad1cbc3aeb0f5193b7a26595966da9621">printName</a> ()</td></tr>

  223. <tr class="separator:ad1cbc3aeb0f5193b7a26595966da9621"><td class="memSeparator" colspan="2">&#160;</td></tr>

  224. <tr class="memitem:afe18a787fb8640e2d2483370c770f82f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afe18a787fb8640e2d2483370c770f82f">printName</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

  225. <tr class="separator:afe18a787fb8640e2d2483370c770f82f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  226. <tr class="memitem:a791cd7aade71f609aab62ec018aea3c0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a791cd7aade71f609aab62ec018aea3c0">printSFN</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

  227. <tr class="separator:a791cd7aade71f609aab62ec018aea3c0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  228. <tr class="memitem:a60ae55ff6fe158c2340071d702a363c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read</a> ()</td></tr>

  229. <tr class="separator:a60ae55ff6fe158c2340071d702a363c5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  230. <tr class="memitem:a200e6e0553d5b709520c9dfac9ef77dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a200e6e0553d5b709520c9dfac9ef77dd">read</a> (void *buf, size_t nbyte)</td></tr>

  231. <tr class="separator:a200e6e0553d5b709520c9dfac9ef77dd"><td class="memSeparator" colspan="2">&#160;</td></tr>

  232. <tr class="memitem:a1325afe074c3efecff666678cd9f116a"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir</a> (<a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir)</td></tr>

  233. <tr class="separator:a1325afe074c3efecff666678cd9f116a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  234. <tr class="memitem:ac837a537fbcca14c7aa390c5fc9f4e7c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac837a537fbcca14c7aa390c5fc9f4e7c">remove</a> ()</td></tr>

  235. <tr class="separator:ac837a537fbcca14c7aa390c5fc9f4e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  236. <tr class="memitem:a4b42f2454ff462555c07ea094a92a1e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4b42f2454ff462555c07ea094a92a1e0">rename</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *newPath)</td></tr>

  237. <tr class="separator:a4b42f2454ff462555c07ea094a92a1e0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  238. <tr class="memitem:a5aac6e0b3cb08fc8b8668e916a8b0ca5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5aac6e0b3cb08fc8b8668e916a8b0ca5">rewind</a> ()</td></tr>

  239. <tr class="separator:a5aac6e0b3cb08fc8b8668e916a8b0ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  240. <tr class="memitem:a9515bac181d33e7f0125e88fa2ccd283"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir</a> ()</td></tr>

  241. <tr class="separator:a9515bac181d33e7f0125e88fa2ccd283"><td class="memSeparator" colspan="2">&#160;</td></tr>

  242. <tr class="memitem:ac780a80526f86d3def701ecdc99d8bfe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac780a80526f86d3def701ecdc99d8bfe">rmRfStar</a> ()</td></tr>

  243. <tr class="separator:ac780a80526f86d3def701ecdc99d8bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>

  244. <tr class="memitem:a5812037ea30777cc350698ad26f2c73f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5812037ea30777cc350698ad26f2c73f">seekCur</a> (int32_t offset)</td></tr>

  245. <tr class="separator:a5812037ea30777cc350698ad26f2c73f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  246. <tr class="memitem:a84f677f4e75ef6fa2eb632f4cdf6b486"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a84f677f4e75ef6fa2eb632f4cdf6b486">seekEnd</a> (int32_t offset=0)</td></tr>

  247. <tr class="separator:a84f677f4e75ef6fa2eb632f4cdf6b486"><td class="memSeparator" colspan="2">&#160;</td></tr>

  248. <tr class="memitem:ab067190d25733ed7e697d9890f61fd7a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet</a> (uint32_t pos)</td></tr>

  249. <tr class="separator:ab067190d25733ed7e697d9890f61fd7a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  250. <tr class="memitem:acf264de4e3ca36c5e8a39e56173c9044"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#acf264de4e3ca36c5e8a39e56173c9044">setpos</a> (<a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *pos)</td></tr>

  251. <tr class="separator:acf264de4e3ca36c5e8a39e56173c9044"><td class="memSeparator" colspan="2">&#160;</td></tr>

  252. <tr class="memitem:a67f3dc4896c542d695e11aac927f585e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync</a> ()</td></tr>

  253. <tr class="separator:a67f3dc4896c542d695e11aac927f585e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  254. <tr class="memitem:aa53a8d1d2467ad9af7d61cbf8ee85243"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa53a8d1d2467ad9af7d61cbf8ee85243">timestamp</a> (<a class="el" href="class_fat_file.html">FatFile</a> *file)</td></tr>

  255. <tr class="separator:aa53a8d1d2467ad9af7d61cbf8ee85243"><td class="memSeparator" colspan="2">&#160;</td></tr>

  256. <tr class="memitem:a56dabdf73833b7e961c4530eb8e16d23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a56dabdf73833b7e961c4530eb8e16d23">timestamp</a> (uint8_t flags, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)</td></tr>

  257. <tr class="separator:a56dabdf73833b7e961c4530eb8e16d23"><td class="memSeparator" colspan="2">&#160;</td></tr>

  258. <tr class="memitem:aa6e663098a578635d37d92e82d18d616"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa6e663098a578635d37d92e82d18d616">truncate</a> (uint32_t length)</td></tr>

  259. <tr class="separator:aa6e663098a578635d37d92e82d18d616"><td class="memSeparator" colspan="2">&#160;</td></tr>

  260. <tr class="memitem:a3c64bd8a9abb9a6461d4addb405614df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a3c64bd8a9abb9a6461d4addb405614df">volume</a> () const </td></tr>

  261. <tr class="separator:a3c64bd8a9abb9a6461d4addb405614df"><td class="memSeparator" colspan="2">&#160;</td></tr>

  262. <tr class="memitem:aa4a5b81161994cea07938702cdfce49f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">write</a> (const char *str)</td></tr>

  263. <tr class="separator:aa4a5b81161994cea07938702cdfce49f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  264. <tr class="memitem:a5524bd9f3b8f54ee163e391cba618186"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write</a> (uint8_t b)</td></tr>

  265. <tr class="separator:a5524bd9f3b8f54ee163e391cba618186"><td class="memSeparator" colspan="2">&#160;</td></tr>

  266. <tr class="memitem:a0ab9df44a9ee4b6eb0a78f15f1e30004"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0ab9df44a9ee4b6eb0a78f15f1e30004">write</a> (const void *buf, size_t nbyte)</td></tr>

  267. <tr class="separator:a0ab9df44a9ee4b6eb0a78f15f1e30004"><td class="memSeparator" colspan="2">&#160;</td></tr>

  268. </table><table class="memberdecls">

  269. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>

  270. Static Public Member Functions</h2></td></tr>

  271. <tr class="memitem:a3b68e603ad8e47bad915f0547e580adb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a3b68e603ad8e47bad915f0547e580adb">cwd</a> ()</td></tr>

  272. <tr class="separator:a3b68e603ad8e47bad915f0547e580adb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  273. <tr class="memitem:a29a623f50df057e8b49045ba6611ec2b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a29a623f50df057e8b49045ba6611ec2b">dateTimeCallback</a> (void(*dateTime)(uint16_t *date, uint16_t *time))</td></tr>

  274. <tr class="separator:a29a623f50df057e8b49045ba6611ec2b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  275. <tr class="memitem:a5df02f1d037e6091375488af25244ebc"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a5df02f1d037e6091375488af25244ebc">dateTimeCallbackCancel</a> ()</td></tr>

  276. <tr class="separator:a5df02f1d037e6091375488af25244ebc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  277. <tr class="memitem:a648461081fe07578780f4cd3f246cb66"><td class="memItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a648461081fe07578780f4cd3f246cb66">dirName</a> (const <a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *dir, char *name)</td></tr>

  278. <tr class="separator:a648461081fe07578780f4cd3f246cb66"><td class="memSeparator" colspan="2">&#160;</td></tr>

  279. <tr class="memitem:a94df8090f16e9666cdc53ca20f6aff90"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a94df8090f16e9666cdc53ca20f6aff90">legal83Char</a> (uint8_t c)</td></tr>

  280. <tr class="separator:a94df8090f16e9666cdc53ca20f6aff90"><td class="memSeparator" colspan="2">&#160;</td></tr>

  281. <tr class="memitem:a8fdb038aafdf3a17ac80b53c063aa73b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8fdb038aafdf3a17ac80b53c063aa73b">printFatDate</a> (uint16_t fatDate)</td></tr>

  282. <tr class="separator:a8fdb038aafdf3a17ac80b53c063aa73b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  283. <tr class="memitem:ada5364f66204b1a64afbf9d2e6cd2b0b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ada5364f66204b1a64afbf9d2e6cd2b0b">printFatDate</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint16_t fatDate)</td></tr>

  284. <tr class="separator:ada5364f66204b1a64afbf9d2e6cd2b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  285. <tr class="memitem:a7740731f08ef97de7dfbc9b075c4c7d1"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7740731f08ef97de7dfbc9b075c4c7d1">printFatTime</a> (uint16_t fatTime)</td></tr>

  286. <tr class="separator:a7740731f08ef97de7dfbc9b075c4c7d1"><td class="memSeparator" colspan="2">&#160;</td></tr>

  287. <tr class="memitem:a4e7e56ba52ca17c602af1b85684b09a9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4e7e56ba52ca17c602af1b85684b09a9">printFatTime</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint16_t fatTime)</td></tr>

  288. <tr class="separator:a4e7e56ba52ca17c602af1b85684b09a9"><td class="memSeparator" colspan="2">&#160;</td></tr>

  289. <tr class="memitem:afe820bbb056863e91ec482961c8dc695"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afe820bbb056863e91ec482961c8dc695">remove</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path)</td></tr>

  290. <tr class="separator:afe820bbb056863e91ec482961c8dc695"><td class="memSeparator" colspan="2">&#160;</td></tr>

  291. <tr class="memitem:a360ef9c05e677271bed6c0a4d663634c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a360ef9c05e677271bed6c0a4d663634c">setCwd</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dir)</td></tr>

  292. <tr class="separator:a360ef9c05e677271bed6c0a4d663634c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  293. </table>

  294. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  295. <div class="textblock"><p>Basic file class. </p>

  296. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  297. <a class="anchor" id="a7b591c9b92165fa8e4eae8c30c30e533"></a>

  298. <div class="memitem">

  299. <div class="memproto">

  300. <table class="mlabels">

  301.   <tr>

  302.   <td class="mlabels-left">

  303.       <table class="memname">

  304.         <tr>

  305.           <td class="memname">FatFile::FatFile </td>

  306.           <td>(</td>

  307.           <td class="paramname"></td><td>)</td>

  308.           <td></td>

  309.         </tr>

  310.       </table>

  311.   </td>

  312.   <td class="mlabels-right">

  313. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  314.   </tr>

  315. </table>

  316. </div><div class="memdoc">

  317. <p>Create an instance. </p>

  318. 

  319. </div>

  320. </div>

  321. <a class="anchor" id="a29d31067d0aa3a9a74b1a660c38775cc"></a>

  322. <div class="memitem">

  323. <div class="memproto">

  324. <table class="mlabels">

  325.   <tr>

  326.   <td class="mlabels-left">

  327.       <table class="memname">

  328.         <tr>

  329.           <td class="memname">FatFile::FatFile </td>

  330.           <td>(</td>

  331.           <td class="paramtype">const char *&#160;</td>

  332.           <td class="paramname"><em>path</em>, </td>

  333.         </tr>

  334.         <tr>

  335.           <td class="paramkey"></td>

  336.           <td></td>

  337.           <td class="paramtype">uint8_t&#160;</td>

  338.           <td class="paramname"><em>oflag</em>&#160;</td>

  339.         </tr>

  340.         <tr>

  341.           <td></td>

  342.           <td>)</td>

  343.           <td></td><td></td>

  344.         </tr>

  345.       </table>

  346.   </td>

  347.   <td class="mlabels-right">

  348. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  349.   </tr>

  350. </table>

  351. </div><div class="memdoc">

  352. <p>Create a file object and open it in the current working directory.</p>

  353. <dl class="params"><dt>Parameters</dt><dd>

  354.   <table class="params">

  355.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for a file to be opened.</td></tr>

  356.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>Values for <em>oflag</em> are constructed by a bitwise-inclusive OR of open flags. see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>. </td></tr>

  357.   </table>

  358.   </dd>

  359. </dl>

  360. 

  361. </div>

  362. </div>

  363. <h2 class="groupheader">Member Function Documentation</h2>

  364. <a class="anchor" id="ac1fa779d98db7ffdb96f8019ab0060d6"></a>

  365. <div class="memitem">

  366. <div class="memproto">

  367. <table class="mlabels">

  368.   <tr>

  369.   <td class="mlabels-left">

  370.       <table class="memname">

  371.         <tr>

  372.           <td class="memname">uint32_t FatFile::available </td>

  373.           <td>(</td>

  374.           <td class="paramname"></td><td>)</td>

  375.           <td></td>

  376.         </tr>

  377.       </table>

  378.   </td>

  379.   <td class="mlabels-right">

  380. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  381.   </tr>

  382. </table>

  383. </div><div class="memdoc">

  384. <dl class="section return"><dt>Returns</dt><dd>The number of bytes available from the current position to EOF for normal files. Zero is returned for directory files. </dd></dl>

  385. 

  386. </div>

  387. </div>

  388. <a class="anchor" id="a052e2c15a39b322a5307b693b8835b22"></a>

  389. <div class="memitem">

  390. <div class="memproto">

  391. <table class="mlabels">

  392.   <tr>

  393.   <td class="mlabels-left">

  394.       <table class="memname">

  395.         <tr>

  396.           <td class="memname">void FatFile::clearError </td>

  397.           <td>(</td>

  398.           <td class="paramname"></td><td>)</td>

  399.           <td></td>

  400.         </tr>

  401.       </table>

  402.   </td>

  403.   <td class="mlabels-right">

  404. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  405.   </tr>

  406. </table>

  407. </div><div class="memdoc">

  408. <p>Clear all error bits. </p>

  409. 

  410. </div>

  411. </div>

  412. <a class="anchor" id="aeca2a2eff91e6aa55fe1b0e3860c9a05"></a>

  413. <div class="memitem">

  414. <div class="memproto">

  415. <table class="mlabels">

  416.   <tr>

  417.   <td class="mlabels-left">

  418.       <table class="memname">

  419.         <tr>

  420.           <td class="memname">void FatFile::clearWriteError </td>

  421.           <td>(</td>

  422.           <td class="paramname"></td><td>)</td>

  423.           <td></td>

  424.         </tr>

  425.       </table>

  426.   </td>

  427.   <td class="mlabels-right">

  428. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  429.   </tr>

  430. </table>

  431. </div><div class="memdoc">

  432. <p>Set writeError to zero </p>

  433. 

  434. </div>

  435. </div>

  436. <a class="anchor" id="afd16af325e0642e4bff6430b7d8bb18b"></a>

  437. <div class="memitem">

  438. <div class="memproto">

  439.       <table class="memname">

  440.         <tr>

  441.           <td class="memname">bool FatFile::close </td>

  442.           <td>(</td>

  443.           <td class="paramname"></td><td>)</td>

  444.           <td></td>

  445.         </tr>

  446.       </table>

  447. </div><div class="memdoc">

  448. <p>Close a file and force cached data and directory information to be written to the storage device.</p>

  449. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  450. 

  451. </div>

  452. </div>

  453. <a class="anchor" id="aa367708bcc8bc0e0c45c0c2a812c65da"></a>

  454. <div class="memitem">

  455. <div class="memproto">

  456.       <table class="memname">

  457.         <tr>

  458.           <td class="memname">bool FatFile::contiguousRange </td>

  459.           <td>(</td>

  460.           <td class="paramtype">uint32_t *&#160;</td>

  461.           <td class="paramname"><em>bgnBlock</em>, </td>

  462.         </tr>

  463.         <tr>

  464.           <td class="paramkey"></td>

  465.           <td></td>

  466.           <td class="paramtype">uint32_t *&#160;</td>

  467.           <td class="paramname"><em>endBlock</em>&#160;</td>

  468.         </tr>

  469.         <tr>

  470.           <td></td>

  471.           <td>)</td>

  472.           <td></td><td></td>

  473.         </tr>

  474.       </table>

  475. </div><div class="memdoc">

  476. <p>Check for contiguous file and return its raw block range.</p>

  477. <dl class="params"><dt>Parameters</dt><dd>

  478.   <table class="params">

  479.     <tr><td class="paramdir">[out]</td><td class="paramname">bgnBlock</td><td>the first block address for the file. </td></tr>

  480.     <tr><td class="paramdir">[out]</td><td class="paramname">endBlock</td><td>the last block address for the file.</td></tr>

  481.   </table>

  482.   </dd>

  483. </dl>

  484. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  485. 

  486. </div>

  487. </div>

  488. <a class="anchor" id="a0afc2a1cffa238d1cb2049bfa2d8d199"></a>

  489. <div class="memitem">

  490. <div class="memproto">

  491.       <table class="memname">

  492.         <tr>

  493.           <td class="memname">bool FatFile::createContiguous </td>

  494.           <td>(</td>

  495.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  496.           <td class="paramname"><em>dirFile</em>, </td>

  497.         </tr>

  498.         <tr>

  499.           <td class="paramkey"></td>

  500.           <td></td>

  501.           <td class="paramtype">const char *&#160;</td>

  502.           <td class="paramname"><em>path</em>, </td>

  503.         </tr>

  504.         <tr>

  505.           <td class="paramkey"></td>

  506.           <td></td>

  507.           <td class="paramtype">uint32_t&#160;</td>

  508.           <td class="paramname"><em>size</em>&#160;</td>

  509.         </tr>

  510.         <tr>

  511.           <td></td>

  512.           <td>)</td>

  513.           <td></td><td></td>

  514.         </tr>

  515.       </table>

  516. </div><div class="memdoc">

  517. <p>Create and open a new contiguous file of a specified size.</p>

  518. <dl class="params"><dt>Parameters</dt><dd>

  519.   <table class="params">

  520.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory where the file will be created. </td></tr>

  521.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid DOS 8.3 file name. </td></tr>

  522.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The desired file size.</td></tr>

  523.   </table>

  524.   </dd>

  525. </dl>

  526. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false, is returned for failure. </dd></dl>

  527. 

  528. </div>

  529. </div>

  530. <a class="anchor" id="a4c03e2f6729526786e6ab4a623e0339b"></a>

  531. <div class="memitem">

  532. <div class="memproto">

  533. <table class="mlabels">

  534.   <tr>

  535.   <td class="mlabels-left">

  536.       <table class="memname">

  537.         <tr>

  538.           <td class="memname">uint32_t FatFile::curCluster </td>

  539.           <td>(</td>

  540.           <td class="paramname"></td><td>)</td>

  541.           <td> const</td>

  542.         </tr>

  543.       </table>

  544.   </td>

  545.   <td class="mlabels-right">

  546. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  547.   </tr>

  548. </table>

  549. </div><div class="memdoc">

  550. <dl class="section return"><dt>Returns</dt><dd>The current cluster number for a file or directory. </dd></dl>

  551. 

  552. </div>

  553. </div>

  554. <a class="anchor" id="a20c55b134bfd1d287a00bf64eba9332e"></a>

  555. <div class="memitem">

  556. <div class="memproto">

  557. <table class="mlabels">

  558.   <tr>

  559.   <td class="mlabels-left">

  560.       <table class="memname">

  561.         <tr>

  562.           <td class="memname">uint32_t FatFile::curPosition </td>

  563.           <td>(</td>

  564.           <td class="paramname"></td><td>)</td>

  565.           <td> const</td>

  566.         </tr>

  567.       </table>

  568.   </td>

  569.   <td class="mlabels-right">

  570. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  571.   </tr>

  572. </table>

  573. </div><div class="memdoc">

  574. <dl class="section return"><dt>Returns</dt><dd>The current position for a file or directory. </dd></dl>

  575. 

  576. </div>

  577. </div>

  578. <a class="anchor" id="a3b68e603ad8e47bad915f0547e580adb"></a>

  579. <div class="memitem">

  580. <div class="memproto">

  581. <table class="mlabels">

  582.   <tr>

  583.   <td class="mlabels-left">

  584.       <table class="memname">

  585.         <tr>

  586.           <td class="memname">static <a class="el" href="class_fat_file.html">FatFile</a>* FatFile::cwd </td>

  587.           <td>(</td>

  588.           <td class="paramname"></td><td>)</td>

  589.           <td></td>

  590.         </tr>

  591.       </table>

  592.   </td>

  593.   <td class="mlabels-right">

  594. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  595.   </tr>

  596. </table>

  597. </div><div class="memdoc">

  598. <dl class="section return"><dt>Returns</dt><dd>Current working directory </dd></dl>

  599. 

  600. </div>

  601. </div>

  602. <a class="anchor" id="a29a623f50df057e8b49045ba6611ec2b"></a>

  603. <div class="memitem">

  604. <div class="memproto">

  605. <table class="mlabels">

  606.   <tr>

  607.   <td class="mlabels-left">

  608.       <table class="memname">

  609.         <tr>

  610.           <td class="memname">static void FatFile::dateTimeCallback </td>

  611.           <td>(</td>

  612.           <td class="paramtype">void(*)(uint16_t *date, uint16_t *time)&#160;</td>

  613.           <td class="paramname"><em>dateTime</em></td><td>)</td>

  614.           <td></td>

  615.         </tr>

  616.       </table>

  617.   </td>

  618.   <td class="mlabels-right">

  619. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  620.   </tr>

  621. </table>

  622. </div><div class="memdoc">

  623. <p>Set the date/time callback function</p>

  624. <dl class="params"><dt>Parameters</dt><dd>

  625.   <table class="params">

  626.     <tr><td class="paramdir">[in]</td><td class="paramname">dateTime</td><td>The user's call back function. The callback function is of the form:</td></tr>

  627.   </table>

  628.   </dd>

  629. </dl>

  630. <div class="fragment"><div class="line"><span class="keywordtype">void</span> dateTime(uint16_t* date, uint16_t* time) {</div>

  631. <div class="line">  uint16_t year;</div>

  632. <div class="line">  uint8_t month, day, hour, minute, second;</div>

  633. <div class="line"></div>

  634. <div class="line">  <span class="comment">// User gets date and time from GPS or real-time clock here</span></div>

  635. <div class="line"></div>

  636. <div class="line">  <span class="comment">// return date using FAT_DATE macro to format fields</span></div>

  637. <div class="line">  *date = <a class="code" href="_fat_structs_8h.html#a44899ad42ddf32ff1c1a73b5251b304a">FAT_DATE</a>(year, month, day);</div>

  638. <div class="line"></div>

  639. <div class="line">  <span class="comment">// return time using FAT_TIME macro to format fields</span></div>

  640. <div class="line">  *time = <a class="code" href="_fat_structs_8h.html#a375720927be5a39475d48b2d75dae29a">FAT_TIME</a>(hour, minute, second);</div>

  641. <div class="line">}</div>

  642. </div><!-- fragment --><p>Sets the function that is called when a file is created or when a file's directory entry is modified by <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a>. All timestamps, access, creation, and modify, are set when a file is created. <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> maintains the last access date and last modify date/time.</p>

  643. <p>See the <a class="el" href="class_fat_file.html#aa53a8d1d2467ad9af7d61cbf8ee85243">timestamp()</a> function. </p>

  644. 

  645. </div>

  646. </div>

  647. <a class="anchor" id="a5df02f1d037e6091375488af25244ebc"></a>

  648. <div class="memitem">

  649. <div class="memproto">

  650. <table class="mlabels">

  651.   <tr>

  652.   <td class="mlabels-left">

  653.       <table class="memname">

  654.         <tr>

  655.           <td class="memname">static void FatFile::dateTimeCallbackCancel </td>

  656.           <td>(</td>

  657.           <td class="paramname"></td><td>)</td>

  658.           <td></td>

  659.         </tr>

  660.       </table>

  661.   </td>

  662.   <td class="mlabels-right">

  663. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  664.   </tr>

  665. </table>

  666. </div><div class="memdoc">

  667. <p>Cancel the date/time callback function. </p>

  668. 

  669. </div>

  670. </div>

  671. <a class="anchor" id="a6858d18c807411a071fd6d1b39d50087"></a>

  672. <div class="memitem">

  673. <div class="memproto">

  674.       <table class="memname">

  675.         <tr>

  676.           <td class="memname">bool FatFile::dirEntry </td>

  677.           <td>(</td>

  678.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  679.           <td class="paramname"><em>dir</em></td><td>)</td>

  680.           <td></td>

  681.         </tr>

  682.       </table>

  683. </div><div class="memdoc">

  684. <p>Return a file's directory entry.</p>

  685. <dl class="params"><dt>Parameters</dt><dd>

  686.   <table class="params">

  687.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>Location for return of the file's directory entry.</td></tr>

  688.   </table>

  689.   </dd>

  690. </dl>

  691. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  692. 

  693. </div>

  694. </div>

  695. <a class="anchor" id="ae5ec24d4a94d3780384d3f2b731c7eb9"></a>

  696. <div class="memitem">

  697. <div class="memproto">

  698. <table class="mlabels">

  699.   <tr>

  700.   <td class="mlabels-left">

  701.       <table class="memname">

  702.         <tr>

  703.           <td class="memname">uint16_t FatFile::dirIndex </td>

  704.           <td>(</td>

  705.           <td class="paramname"></td><td>)</td>

  706.           <td></td>

  707.         </tr>

  708.       </table>

  709.   </td>

  710.   <td class="mlabels-right">

  711. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  712.   </tr>

  713. </table>

  714. </div><div class="memdoc">

  715. <dl class="section return"><dt>Returns</dt><dd>The index of this file in it's directory. </dd></dl>

  716. 

  717. </div>

  718. </div>

  719. <a class="anchor" id="a648461081fe07578780f4cd3f246cb66"></a>

  720. <div class="memitem">

  721. <div class="memproto">

  722. <table class="mlabels">

  723.   <tr>

  724.   <td class="mlabels-left">

  725.       <table class="memname">

  726.         <tr>

  727.           <td class="memname">uint8_t FatFile::dirName </td>

  728.           <td>(</td>

  729.           <td class="paramtype">const <a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  730.           <td class="paramname"><em>dir</em>, </td>

  731.         </tr>

  732.         <tr>

  733.           <td class="paramkey"></td>

  734.           <td></td>

  735.           <td class="paramtype">char *&#160;</td>

  736.           <td class="paramname"><em>name</em>&#160;</td>

  737.         </tr>

  738.         <tr>

  739.           <td></td>

  740.           <td>)</td>

  741.           <td></td><td></td>

  742.         </tr>

  743.       </table>

  744.   </td>

  745.   <td class="mlabels-right">

  746. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  747.   </tr>

  748. </table>

  749. </div><div class="memdoc">

  750. <p>Format the name field of <em>dir</em> into the 13 byte array <em>name</em> in standard 8.3 short name format.</p>

  751. <dl class="params"><dt>Parameters</dt><dd>

  752.   <table class="params">

  753.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>The directory structure containing the name. </td></tr>

  754.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>A 13 byte char array for the formatted name. </td></tr>

  755.   </table>

  756.   </dd>

  757. </dl>

  758. <dl class="section return"><dt>Returns</dt><dd>length of the name. </dd></dl>

  759. 

  760. </div>

  761. </div>

  762. <a class="anchor" id="ae2ed15f05c9ccbce355e7a8d3ce8382d"></a>

  763. <div class="memitem">

  764. <div class="memproto">

  765.       <table class="memname">

  766.         <tr>

  767.           <td class="memname">uint32_t FatFile::dirSize </td>

  768.           <td>(</td>

  769.           <td class="paramname"></td><td>)</td>

  770.           <td></td>

  771.         </tr>

  772.       </table>

  773. </div><div class="memdoc">

  774. <dl class="section return"><dt>Returns</dt><dd>The number of bytes allocated to a directory or zero if an error occurs. </dd></dl>

  775. 

  776. </div>

  777. </div>

  778. <a class="anchor" id="a4f01d27954ae49aeb6888ac7302f55d9"></a>

  779. <div class="memitem">

  780. <div class="memproto">

  781.       <table class="memname">

  782.         <tr>

  783.           <td class="memname">void FatFile::dmpFile </td>

  784.           <td>(</td>

  785.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  786.           <td class="paramname"><em>pr</em>, </td>

  787.         </tr>

  788.         <tr>

  789.           <td class="paramkey"></td>

  790.           <td></td>

  791.           <td class="paramtype">uint32_t&#160;</td>

  792.           <td class="paramname"><em>pos</em>, </td>

  793.         </tr>

  794.         <tr>

  795.           <td class="paramkey"></td>

  796.           <td></td>

  797.           <td class="paramtype">size_t&#160;</td>

  798.           <td class="paramname"><em>n</em>&#160;</td>

  799.         </tr>

  800.         <tr>

  801.           <td></td>

  802.           <td>)</td>

  803.           <td></td><td></td>

  804.         </tr>

  805.       </table>

  806. </div><div class="memdoc">

  807. <p>Dump file in Hex </p><dl class="params"><dt>Parameters</dt><dd>

  808.   <table class="params">

  809.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list. </td></tr>

  810.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>Start position in file. </td></tr>

  811.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number of locations to dump. </td></tr>

  812.   </table>

  813.   </dd>

  814. </dl>

  815. 

  816. </div>

  817. </div>

  818. <a class="anchor" id="a50242f98dea0d4488ce4039a279f2a57"></a>

  819. <div class="memitem">

  820. <div class="memproto">

  821. <table class="mlabels">

  822.   <tr>

  823.   <td class="mlabels-left">

  824.       <table class="memname">

  825.         <tr>

  826.           <td class="memname">bool FatFile::exists </td>

  827.           <td>(</td>

  828.           <td class="paramtype">const char *&#160;</td>

  829.           <td class="paramname"><em>path</em></td><td>)</td>

  830.           <td></td>

  831.         </tr>

  832.       </table>

  833.   </td>

  834.   <td class="mlabels-right">

  835. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  836.   </tr>

  837. </table>

  838. </div><div class="memdoc">

  839. <p>Test for the existence of a file in a directory</p>

  840. <dl class="params"><dt>Parameters</dt><dd>

  841.   <table class="params">

  842.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>

  843.   </table>

  844.   </dd>

  845. </dl>

  846. <p>The calling instance must be an open directory file.</p>

  847. <p>dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.</p>

  848. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>

  849. 

  850. </div>

  851. </div>

  852. <a class="anchor" id="a31ef26b3ee37cf5f5f4c6024c0ddab69"></a>

  853. <div class="memitem">

  854. <div class="memproto">

  855.       <table class="memname">

  856.         <tr>

  857.           <td class="memname">int16_t FatFile::fgets </td>

  858.           <td>(</td>

  859.           <td class="paramtype">char *&#160;</td>

  860.           <td class="paramname"><em>str</em>, </td>

  861.         </tr>

  862.         <tr>

  863.           <td class="paramkey"></td>

  864.           <td></td>

  865.           <td class="paramtype">int16_t&#160;</td>

  866.           <td class="paramname"><em>num</em>, </td>

  867.         </tr>

  868.         <tr>

  869.           <td class="paramkey"></td>

  870.           <td></td>

  871.           <td class="paramtype">char *&#160;</td>

  872.           <td class="paramname"><em>delim</em> = <code>0</code>&#160;</td>

  873.         </tr>

  874.         <tr>

  875.           <td></td>

  876.           <td>)</td>

  877.           <td></td><td></td>

  878.         </tr>

  879.       </table>

  880. </div><div class="memdoc">

  881. <p>Get a string from a file.</p>

  882. <p><a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> reads bytes from a file into the array pointed to by <em>str</em>, until <em>num</em> - 1 bytes are read, or a delimiter is read and transferred to <em>str</em>, or end-of-file is encountered. The string is then terminated with a null byte.</p>

  883. <p><a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> deletes CR, '\r', from the string. This insures only a '\n' terminates the string for Windows text files which use CRLF for newline.</p>

  884. <dl class="params"><dt>Parameters</dt><dd>

  885.   <table class="params">

  886.     <tr><td class="paramdir">[out]</td><td class="paramname">str</td><td>Pointer to the array where the string is stored. </td></tr>

  887.     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Maximum number of characters to be read (including the final null byte). Usually the length of the array <em>str</em> is used. </td></tr>

  888.     <tr><td class="paramdir">[in]</td><td class="paramname">delim</td><td>Optional set of delimiters. The default is "\n".</td></tr>

  889.   </table>

  890.   </dd>

  891. </dl>

  892. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> returns the length of the string in <em>str</em>. If no data is read, <a class="el" href="class_fat_file.html#a31ef26b3ee37cf5f5f4c6024c0ddab69">fgets()</a> returns zero for EOF or -1 if an error occurred. </dd></dl>

  893. 

  894. </div>

  895. </div>

  896. <a class="anchor" id="a7e043dfb89d268bfd620bbbadacf1002"></a>

  897. <div class="memitem">

  898. <div class="memproto">

  899. <table class="mlabels">

  900.   <tr>

  901.   <td class="mlabels-left">

  902.       <table class="memname">

  903.         <tr>

  904.           <td class="memname">uint8_t FatFile::fileAttr </td>

  905.           <td>(</td>

  906.           <td class="paramname"></td><td>)</td>

  907.           <td> const</td>

  908.         </tr>

  909.       </table>

  910.   </td>

  911.   <td class="mlabels-right">

  912. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  913.   </tr>

  914. </table>

  915. </div><div class="memdoc">

  916. <p>Type of file. You should use <a class="el" href="class_fat_file.html#afcf6270ea8d4a3a5f8e89523bc684e22">isFile()</a> or <a class="el" href="class_fat_file.html#aef41d65e0f1ce753d18cc9ed691f7de4">isDir()</a> instead of fileType() if possible.</p>

  917. <dl class="section return"><dt>Returns</dt><dd>The file or directory type. </dd></dl>

  918. 

  919. </div>

  920. </div>

  921. <a class="anchor" id="a02fc3b3ca36b4745f695f3de8c8ec36d"></a>

  922. <div class="memitem">

  923. <div class="memproto">

  924. <table class="mlabels">

  925.   <tr>

  926.   <td class="mlabels-left">

  927.       <table class="memname">

  928.         <tr>

  929.           <td class="memname">uint32_t FatFile::fileSize </td>

  930.           <td>(</td>

  931.           <td class="paramname"></td><td>)</td>

  932.           <td> const</td>

  933.         </tr>

  934.       </table>

  935.   </td>

  936.   <td class="mlabels-right">

  937. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  938.   </tr>

  939. </table>

  940. </div><div class="memdoc">

  941. <dl class="section return"><dt>Returns</dt><dd>The total number of bytes in a file. </dd></dl>

  942. 

  943. </div>

  944. </div>

  945. <a class="anchor" id="a1057bc23b92a074539f661e896e79a09"></a>

  946. <div class="memitem">

  947. <div class="memproto">

  948. <table class="mlabels">

  949.   <tr>

  950.   <td class="mlabels-left">

  951.       <table class="memname">

  952.         <tr>

  953.           <td class="memname">uint32_t FatFile::firstCluster </td>

  954.           <td>(</td>

  955.           <td class="paramname"></td><td>)</td>

  956.           <td> const</td>

  957.         </tr>

  958.       </table>

  959.   </td>

  960.   <td class="mlabels-right">

  961. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  962.   </tr>

  963. </table>

  964. </div><div class="memdoc">

  965. <dl class="section return"><dt>Returns</dt><dd>The first cluster number for a file or directory. </dd></dl>

  966. 

  967. </div>

  968. </div>

  969. <a class="anchor" id="ad0dbbd083180f44c7a3ce7124d4ce19c"></a>

  970. <div class="memitem">

  971. <div class="memproto">

  972. <table class="mlabels">

  973.   <tr>

  974.   <td class="mlabels-left">

  975.       <table class="memname">

  976.         <tr>

  977.           <td class="memname">uint8_t FatFile::getError </td>

  978.           <td>(</td>

  979.           <td class="paramname"></td><td>)</td>

  980.           <td></td>

  981.         </tr>

  982.       </table>

  983.   </td>

  984.   <td class="mlabels-right">

  985. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  986.   </tr>

  987. </table>

  988. </div><div class="memdoc">

  989. <dl class="section return"><dt>Returns</dt><dd>All error bits. </dd></dl>

  990. 

  991. </div>

  992. </div>

  993. <a class="anchor" id="aafa565e286440aab612cdb430fc01da5"></a>

  994. <div class="memitem">

  995. <div class="memproto">

  996.       <table class="memname">

  997.         <tr>

  998.           <td class="memname">bool FatFile::getName </td>

  999.           <td>(</td>

  1000.           <td class="paramtype">char *&#160;</td>

  1001.           <td class="paramname"><em>name</em>, </td>

  1002.         </tr>

  1003.         <tr>

  1004.           <td class="paramkey"></td>

  1005.           <td></td>

  1006.           <td class="paramtype">size_t&#160;</td>

  1007.           <td class="paramname"><em>size</em>&#160;</td>

  1008.         </tr>

  1009.         <tr>

  1010.           <td></td>

  1011.           <td>)</td>

  1012.           <td></td><td></td>

  1013.         </tr>

  1014.       </table>

  1015. </div><div class="memdoc">

  1016. <p>Get a file's name followed by a zero byte.</p>

  1017. <dl class="params"><dt>Parameters</dt><dd>

  1018.   <table class="params">

  1019.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. </td></tr>

  1020.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the array in bytes. The array must be at least 13 bytes long. The file's name will be truncated if the file's name is too long. </td></tr>

  1021.   </table>

  1022.   </dd>

  1023. </dl>

  1024. <dl class="section return"><dt>Returns</dt><dd>The value true, is returned for success and the value false, is returned for failure. </dd></dl>

  1025. 

  1026. </div>

  1027. </div>

  1028. <a class="anchor" id="aaa4f9886887947815a61eaf015996932"></a>

  1029. <div class="memitem">

  1030. <div class="memproto">

  1031.       <table class="memname">

  1032.         <tr>

  1033.           <td class="memname">void FatFile::getpos </td>

  1034.           <td>(</td>

  1035.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  1036.           <td class="paramname"><em>pos</em></td><td>)</td>

  1037.           <td></td>

  1038.         </tr>

  1039.       </table>

  1040. </div><div class="memdoc">

  1041. <p>get position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  1042.   <table class="params">

  1043.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct to receive position </td></tr>

  1044.   </table>

  1045.   </dd>

  1046. </dl>

  1047. 

  1048. </div>

  1049. </div>

  1050. <a class="anchor" id="aba30e92a66f8e0d2f815c85662772a58"></a>

  1051. <div class="memitem">

  1052. <div class="memproto">

  1053.       <table class="memname">

  1054.         <tr>

  1055.           <td class="memname">bool FatFile::getSFN </td>

  1056.           <td>(</td>

  1057.           <td class="paramtype">char *&#160;</td>

  1058.           <td class="paramname"><em>name</em></td><td>)</td>

  1059.           <td></td>

  1060.         </tr>

  1061.       </table>

  1062. </div><div class="memdoc">

  1063. <p>Get a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name followed by a zero byte.</p>

  1064. <dl class="params"><dt>Parameters</dt><dd>

  1065.   <table class="params">

  1066.     <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. The array must be at least 13 bytes long. </td></tr>

  1067.   </table>

  1068.   </dd>

  1069. </dl>

  1070. <dl class="section return"><dt>Returns</dt><dd>The value true, is returned for success and the value false, is returned for failure. </dd></dl>

  1071. 

  1072. </div>

  1073. </div>

  1074. <a class="anchor" id="a8062c0d3a118e8d77d0310418703d5f5"></a>

  1075. <div class="memitem">

  1076. <div class="memproto">

  1077. <table class="mlabels">

  1078.   <tr>

  1079.   <td class="mlabels-left">

  1080.       <table class="memname">

  1081.         <tr>

  1082.           <td class="memname">bool FatFile::getWriteError </td>

  1083.           <td>(</td>

  1084.           <td class="paramname"></td><td>)</td>

  1085.           <td></td>

  1086.         </tr>

  1087.       </table>

  1088.   </td>

  1089.   <td class="mlabels-right">

  1090. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1091.   </tr>

  1092. </table>

  1093. </div><div class="memdoc">

  1094. <dl class="section return"><dt>Returns</dt><dd>value of writeError </dd></dl>

  1095. 

  1096. </div>

  1097. </div>

  1098. <a class="anchor" id="aef41d65e0f1ce753d18cc9ed691f7de4"></a>

  1099. <div class="memitem">

  1100. <div class="memproto">

  1101. <table class="mlabels">

  1102.   <tr>

  1103.   <td class="mlabels-left">

  1104.       <table class="memname">

  1105.         <tr>

  1106.           <td class="memname">bool FatFile::isDir </td>

  1107.           <td>(</td>

  1108.           <td class="paramname"></td><td>)</td>

  1109.           <td> const</td>

  1110.         </tr>

  1111.       </table>

  1112.   </td>

  1113.   <td class="mlabels-right">

  1114. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1115.   </tr>

  1116. </table>

  1117. </div><div class="memdoc">

  1118. <dl class="section return"><dt>Returns</dt><dd>True if this is a directory else false. </dd></dl>

  1119. 

  1120. </div>

  1121. </div>

  1122. <a class="anchor" id="afcf6270ea8d4a3a5f8e89523bc684e22"></a>

  1123. <div class="memitem">

  1124. <div class="memproto">

  1125. <table class="mlabels">

  1126.   <tr>

  1127.   <td class="mlabels-left">

  1128.       <table class="memname">

  1129.         <tr>

  1130.           <td class="memname">bool FatFile::isFile </td>

  1131.           <td>(</td>

  1132.           <td class="paramname"></td><td>)</td>

  1133.           <td> const</td>

  1134.         </tr>

  1135.       </table>

  1136.   </td>

  1137.   <td class="mlabels-right">

  1138. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1139.   </tr>

  1140. </table>

  1141. </div><div class="memdoc">

  1142. <dl class="section return"><dt>Returns</dt><dd>True if this is a normal file else false. </dd></dl>

  1143. 

  1144. </div>

  1145. </div>

  1146. <a class="anchor" id="a7eefe7408f34b6326f0c6e78af7eb05f"></a>

  1147. <div class="memitem">

  1148. <div class="memproto">

  1149. <table class="mlabels">

  1150.   <tr>

  1151.   <td class="mlabels-left">

  1152.       <table class="memname">

  1153.         <tr>

  1154.           <td class="memname">bool FatFile::isHidden </td>

  1155.           <td>(</td>

  1156.           <td class="paramname"></td><td>)</td>

  1157.           <td> const</td>

  1158.         </tr>

  1159.       </table>

  1160.   </td>

  1161.   <td class="mlabels-right">

  1162. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1163.   </tr>

  1164. </table>

  1165. </div><div class="memdoc">

  1166. <dl class="section return"><dt>Returns</dt><dd>True if this is a hidden file else false. </dd></dl>

  1167. 

  1168. </div>

  1169. </div>

  1170. <a class="anchor" id="aed36d17f8fde597b6ed9446faec1f7e3"></a>

  1171. <div class="memitem">

  1172. <div class="memproto">

  1173. <table class="mlabels">

  1174.   <tr>

  1175.   <td class="mlabels-left">

  1176.       <table class="memname">

  1177.         <tr>

  1178.           <td class="memname">bool FatFile::isLFN </td>

  1179.           <td>(</td>

  1180.           <td class="paramname"></td><td>)</td>

  1181.           <td> const</td>

  1182.         </tr>

  1183.       </table>

  1184.   </td>

  1185.   <td class="mlabels-right">

  1186. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1187.   </tr>

  1188. </table>

  1189. </div><div class="memdoc">

  1190. <dl class="section return"><dt>Returns</dt><dd>true if this file has a Long <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name. </dd></dl>

  1191. 

  1192. </div>

  1193. </div>

  1194. <a class="anchor" id="a4c8a07b081f04aa25839c6f56c739bdc"></a>

  1195. <div class="memitem">

  1196. <div class="memproto">

  1197. <table class="mlabels">

  1198.   <tr>

  1199.   <td class="mlabels-left">

  1200.       <table class="memname">

  1201.         <tr>

  1202.           <td class="memname">bool FatFile::isOpen </td>

  1203.           <td>(</td>

  1204.           <td class="paramname"></td><td>)</td>

  1205.           <td> const</td>

  1206.         </tr>

  1207.       </table>

  1208.   </td>

  1209.   <td class="mlabels-right">

  1210. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1211.   </tr>

  1212. </table>

  1213. </div><div class="memdoc">

  1214. <dl class="section return"><dt>Returns</dt><dd>True if this is an open file/directory else false. </dd></dl>

  1215. 

  1216. </div>

  1217. </div>

  1218. <a class="anchor" id="a6872d3acb1e70f81c9c2be2495977583"></a>

  1219. <div class="memitem">

  1220. <div class="memproto">

  1221. <table class="mlabels">

  1222.   <tr>

  1223.   <td class="mlabels-left">

  1224.       <table class="memname">

  1225.         <tr>

  1226.           <td class="memname">bool FatFile::isReadOnly </td>

  1227.           <td>(</td>

  1228.           <td class="paramname"></td><td>)</td>

  1229.           <td> const</td>

  1230.         </tr>

  1231.       </table>

  1232.   </td>

  1233.   <td class="mlabels-right">

  1234. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1235.   </tr>

  1236. </table>

  1237. </div><div class="memdoc">

  1238. <dl class="section return"><dt>Returns</dt><dd>True if file is read-only </dd></dl>

  1239. 

  1240. </div>

  1241. </div>

  1242. <a class="anchor" id="aa4a206803a4bf8243be20244c1aef4d2"></a>

  1243. <div class="memitem">

  1244. <div class="memproto">

  1245. <table class="mlabels">

  1246.   <tr>

  1247.   <td class="mlabels-left">

  1248.       <table class="memname">

  1249.         <tr>

  1250.           <td class="memname">bool FatFile::isRoot </td>

  1251.           <td>(</td>

  1252.           <td class="paramname"></td><td>)</td>

  1253.           <td> const</td>

  1254.         </tr>

  1255.       </table>

  1256.   </td>

  1257.   <td class="mlabels-right">

  1258. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1259.   </tr>

  1260. </table>

  1261. </div><div class="memdoc">

  1262. <dl class="section return"><dt>Returns</dt><dd>True if this is the root directory. </dd></dl>

  1263. 

  1264. </div>

  1265. </div>

  1266. <a class="anchor" id="a1449b294e3a838396c62e47674ca8cf0"></a>

  1267. <div class="memitem">

  1268. <div class="memproto">

  1269. <table class="mlabels">

  1270.   <tr>

  1271.   <td class="mlabels-left">

  1272.       <table class="memname">

  1273.         <tr>

  1274.           <td class="memname">bool FatFile::isRoot32 </td>

  1275.           <td>(</td>

  1276.           <td class="paramname"></td><td>)</td>

  1277.           <td> const</td>

  1278.         </tr>

  1279.       </table>

  1280.   </td>

  1281.   <td class="mlabels-right">

  1282. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1283.   </tr>

  1284. </table>

  1285. </div><div class="memdoc">

  1286. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT32 root directory. </dd></dl>

  1287. 

  1288. </div>

  1289. </div>

  1290. <a class="anchor" id="a8215bd4b21e11ec83fa88ef226ceb06f"></a>

  1291. <div class="memitem">

  1292. <div class="memproto">

  1293. <table class="mlabels">

  1294.   <tr>

  1295.   <td class="mlabels-left">

  1296.       <table class="memname">

  1297.         <tr>

  1298.           <td class="memname">bool FatFile::isRootFixed </td>

  1299.           <td>(</td>

  1300.           <td class="paramname"></td><td>)</td>

  1301.           <td> const</td>

  1302.         </tr>

  1303.       </table>

  1304.   </td>

  1305.   <td class="mlabels-right">

  1306. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1307.   </tr>

  1308. </table>

  1309. </div><div class="memdoc">

  1310. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT12 of FAT16 root directory. </dd></dl>

  1311. 

  1312. </div>

  1313. </div>

  1314. <a class="anchor" id="a95b503b17442c2b364a2f53de1b2aeba"></a>

  1315. <div class="memitem">

  1316. <div class="memproto">

  1317. <table class="mlabels">

  1318.   <tr>

  1319.   <td class="mlabels-left">

  1320.       <table class="memname">

  1321.         <tr>

  1322.           <td class="memname">bool FatFile::isSubDir </td>

  1323.           <td>(</td>

  1324.           <td class="paramname"></td><td>)</td>

  1325.           <td> const</td>

  1326.         </tr>

  1327.       </table>

  1328.   </td>

  1329.   <td class="mlabels-right">

  1330. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1331.   </tr>

  1332. </table>

  1333. </div><div class="memdoc">

  1334. <dl class="section return"><dt>Returns</dt><dd>True if this is a subdirectory else false. </dd></dl>

  1335. 

  1336. </div>

  1337. </div>

  1338. <a class="anchor" id="add932e13e5bf32ad467af6ec34824e3c"></a>

  1339. <div class="memitem">

  1340. <div class="memproto">

  1341. <table class="mlabels">

  1342.   <tr>

  1343.   <td class="mlabels-left">

  1344.       <table class="memname">

  1345.         <tr>

  1346.           <td class="memname">bool FatFile::isSystem </td>

  1347.           <td>(</td>

  1348.           <td class="paramname"></td><td>)</td>

  1349.           <td> const</td>

  1350.         </tr>

  1351.       </table>

  1352.   </td>

  1353.   <td class="mlabels-right">

  1354. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1355.   </tr>

  1356. </table>

  1357. </div><div class="memdoc">

  1358. <dl class="section return"><dt>Returns</dt><dd>True if this is a system file else false. </dd></dl>

  1359. 

  1360. </div>

  1361. </div>

  1362. <a class="anchor" id="a94df8090f16e9666cdc53ca20f6aff90"></a>

  1363. <div class="memitem">

  1364. <div class="memproto">

  1365. <table class="mlabels">

  1366.   <tr>

  1367.   <td class="mlabels-left">

  1368.       <table class="memname">

  1369.         <tr>

  1370.           <td class="memname">static bool FatFile::legal83Char </td>

  1371.           <td>(</td>

  1372.           <td class="paramtype">uint8_t&#160;</td>

  1373.           <td class="paramname"><em>c</em></td><td>)</td>

  1374.           <td></td>

  1375.         </tr>

  1376.       </table>

  1377.   </td>

  1378.   <td class="mlabels-right">

  1379. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  1380.   </tr>

  1381. </table>

  1382. </div><div class="memdoc">

  1383. <p>Check for a legal 8.3 character. </p><dl class="params"><dt>Parameters</dt><dd>

  1384.   <table class="params">

  1385.     <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Character to be checked. </td></tr>

  1386.   </table>

  1387.   </dd>

  1388. </dl>

  1389. <dl class="section return"><dt>Returns</dt><dd>true for a legal 8.3 character else false. </dd></dl>

  1390. 

  1391. </div>

  1392. </div>

  1393. <a class="anchor" id="ad49f688a494b351ccbb0102dcfafb925"></a>

  1394. <div class="memitem">

  1395. <div class="memproto">

  1396. <table class="mlabels">

  1397.   <tr>

  1398.   <td class="mlabels-left">

  1399.       <table class="memname">

  1400.         <tr>

  1401.           <td class="memname">void FatFile::ls </td>

  1402.           <td>(</td>

  1403.           <td class="paramtype">uint8_t&#160;</td>

  1404.           <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>

  1405.           <td></td>

  1406.         </tr>

  1407.       </table>

  1408.   </td>

  1409.   <td class="mlabels-right">

  1410. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1411.   </tr>

  1412. </table>

  1413. </div><div class="memdoc">

  1414. <p>List directory contents.</p>

  1415. <dl class="params"><dt>Parameters</dt><dd>

  1416.   <table class="params">

  1417.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  1418.   </table>

  1419.   </dd>

  1420. </dl>

  1421. <p>LS_DATE - Print file modification date</p>

  1422. <p>LS_SIZE - Print file size.</p>

  1423. <p>LS_R - Recursive list of subdirectories. </p>

  1424. 

  1425. </div>

  1426. </div>

  1427. <a class="anchor" id="acabf31ff85e696fbf384c49428012fea"></a>

  1428. <div class="memitem">

  1429. <div class="memproto">

  1430.       <table class="memname">

  1431.         <tr>

  1432.           <td class="memname">void FatFile::ls </td>

  1433.           <td>(</td>

  1434.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1435.           <td class="paramname"><em>pr</em>, </td>

  1436.         </tr>

  1437.         <tr>

  1438.           <td class="paramkey"></td>

  1439.           <td></td>

  1440.           <td class="paramtype">uint8_t&#160;</td>

  1441.           <td class="paramname"><em>flags</em> = <code>0</code>, </td>

  1442.         </tr>

  1443.         <tr>

  1444.           <td class="paramkey"></td>

  1445.           <td></td>

  1446.           <td class="paramtype">uint8_t&#160;</td>

  1447.           <td class="paramname"><em>indent</em> = <code>0</code>&#160;</td>

  1448.         </tr>

  1449.         <tr>

  1450.           <td></td>

  1451.           <td>)</td>

  1452.           <td></td><td></td>

  1453.         </tr>

  1454.       </table>

  1455. </div><div class="memdoc">

  1456. <p>List directory contents.</p>

  1457. <dl class="params"><dt>Parameters</dt><dd>

  1458.   <table class="params">

  1459.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>

  1460.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  1461.   </table>

  1462.   </dd>

  1463. </dl>

  1464. <p>LS_DATE - Print file modification date</p>

  1465. <p>LS_SIZE - Print file size.</p>

  1466. <p>LS_R - Recursive list of subdirectories.</p>

  1467. <dl class="params"><dt>Parameters</dt><dd>

  1468.   <table class="params">

  1469.     <tr><td class="paramdir">[in]</td><td class="paramname">indent</td><td>Amount of space before file name. Used for recursive list to indicate subdirectory level. </td></tr>

  1470.   </table>

  1471.   </dd>

  1472. </dl>

  1473. 

  1474. </div>

  1475. </div>

  1476. <a class="anchor" id="abab5b9f72cc796388dd4eed01d13d90d"></a>

  1477. <div class="memitem">

  1478. <div class="memproto">

  1479.       <table class="memname">

  1480.         <tr>

  1481.           <td class="memname">bool FatFile::mkdir </td>

  1482.           <td>(</td>

  1483.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1484.           <td class="paramname"><em>dir</em>, </td>

  1485.         </tr>

  1486.         <tr>

  1487.           <td class="paramkey"></td>

  1488.           <td></td>

  1489.           <td class="paramtype">const char *&#160;</td>

  1490.           <td class="paramname"><em>path</em>, </td>

  1491.         </tr>

  1492.         <tr>

  1493.           <td class="paramkey"></td>

  1494.           <td></td>

  1495.           <td class="paramtype">bool&#160;</td>

  1496.           <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>

  1497.         </tr>

  1498.         <tr>

  1499.           <td></td>

  1500.           <td>)</td>

  1501.           <td></td><td></td>

  1502.         </tr>

  1503.       </table>

  1504. </div><div class="memdoc">

  1505. <p>Make a new directory.</p>

  1506. <dl class="params"><dt>Parameters</dt><dd>

  1507.   <table class="params">

  1508.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory that will contain the new directory.</td></tr>

  1509.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the new directory.</td></tr>

  1510.     <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>

  1511.   </table>

  1512.   </dd>

  1513. </dl>

  1514. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1515. 

  1516. </div>

  1517. </div>

  1518. <a class="anchor" id="a5f64576d3d19177ab3cf3812b69abdfa"></a>

  1519. <div class="memitem">

  1520. <div class="memproto">

  1521.       <table class="memname">

  1522.         <tr>

  1523.           <td class="memname">bool FatFile::open </td>

  1524.           <td>(</td>

  1525.           <td class="paramtype"><a class="el" href="class_fat_file_system.html">FatFileSystem</a> *&#160;</td>

  1526.           <td class="paramname"><em>fs</em>, </td>

  1527.         </tr>

  1528.         <tr>

  1529.           <td class="paramkey"></td>

  1530.           <td></td>

  1531.           <td class="paramtype">const char *&#160;</td>

  1532.           <td class="paramname"><em>path</em>, </td>

  1533.         </tr>

  1534.         <tr>

  1535.           <td class="paramkey"></td>

  1536.           <td></td>

  1537.           <td class="paramtype">uint8_t&#160;</td>

  1538.           <td class="paramname"><em>oflag</em>&#160;</td>

  1539.         </tr>

  1540.         <tr>

  1541.           <td></td>

  1542.           <td>)</td>

  1543.           <td></td><td></td>

  1544.         </tr>

  1545.       </table>

  1546. </div><div class="memdoc">

  1547. <p>Open a file in the volume working directory of a <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a>.</p>

  1548. <dl class="params"><dt>Parameters</dt><dd>

  1549.   <table class="params">

  1550.     <tr><td class="paramdir">[in]</td><td class="paramname">fs</td><td><a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> System where the file is located.</td></tr>

  1551.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid 8.3 DOS name for a file to be opened.</td></tr>

  1552.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1553.   </table>

  1554.   </dd>

  1555. </dl>

  1556. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1557. 

  1558. </div>

  1559. </div>

  1560. <a class="anchor" id="ad3fa9daaccb4e4179fb88a8ca037aa80"></a>

  1561. <div class="memitem">

  1562. <div class="memproto">

  1563.       <table class="memname">

  1564.         <tr>

  1565.           <td class="memname">bool FatFile::open </td>

  1566.           <td>(</td>

  1567.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1568.           <td class="paramname"><em>dirFile</em>, </td>

  1569.         </tr>

  1570.         <tr>

  1571.           <td class="paramkey"></td>

  1572.           <td></td>

  1573.           <td class="paramtype">uint16_t&#160;</td>

  1574.           <td class="paramname"><em>index</em>, </td>

  1575.         </tr>

  1576.         <tr>

  1577.           <td class="paramkey"></td>

  1578.           <td></td>

  1579.           <td class="paramtype">uint8_t&#160;</td>

  1580.           <td class="paramname"><em>oflag</em>&#160;</td>

  1581.         </tr>

  1582.         <tr>

  1583.           <td></td>

  1584.           <td>)</td>

  1585.           <td></td><td></td>

  1586.         </tr>

  1587.       </table>

  1588. </div><div class="memdoc">

  1589. <p>Open a file by index.</p>

  1590. <dl class="params"><dt>Parameters</dt><dd>

  1591.   <table class="params">

  1592.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory.</td></tr>

  1593.     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The <em>index</em> of the directory entry for the file to be opened. The value for <em>index</em> is (directory file position)/32.</td></tr>

  1594.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1595.   </table>

  1596.   </dd>

  1597. </dl>

  1598. <p>See <a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open()</a> by path for definition of flags. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1599. 

  1600. </div>

  1601. </div>

  1602. <a class="anchor" id="a211be757679b18708f6b6a36464e4f61"></a>

  1603. <div class="memitem">

  1604. <div class="memproto">

  1605.       <table class="memname">

  1606.         <tr>

  1607.           <td class="memname">bool FatFile::open </td>

  1608.           <td>(</td>

  1609.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1610.           <td class="paramname"><em>dirFile</em>, </td>

  1611.         </tr>

  1612.         <tr>

  1613.           <td class="paramkey"></td>

  1614.           <td></td>

  1615.           <td class="paramtype">const char *&#160;</td>

  1616.           <td class="paramname"><em>path</em>, </td>

  1617.         </tr>

  1618.         <tr>

  1619.           <td class="paramkey"></td>

  1620.           <td></td>

  1621.           <td class="paramtype">uint8_t&#160;</td>

  1622.           <td class="paramname"><em>oflag</em>&#160;</td>

  1623.         </tr>

  1624.         <tr>

  1625.           <td></td>

  1626.           <td>)</td>

  1627.           <td></td><td></td>

  1628.         </tr>

  1629.       </table>

  1630. </div><div class="memdoc">

  1631. <p>Open a file or directory by name.</p>

  1632. <dl class="params"><dt>Parameters</dt><dd>

  1633.   <table class="params">

  1634.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory containing the file to be opened.</td></tr>

  1635.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for a file to be opened.</td></tr>

  1636.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>Values for <em>oflag</em> are constructed by a bitwise-inclusive OR of flags from the following list</td></tr>

  1637.   </table>

  1638.   </dd>

  1639. </dl>

  1640. <p>O_READ - Open for reading.</p>

  1641. <p>O_RDONLY - Same as O_READ.</p>

  1642. <p>O_WRITE - Open for writing.</p>

  1643. <p>O_WRONLY - Same as O_WRITE.</p>

  1644. <p>O_RDWR - Open for reading and writing.</p>

  1645. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>

  1646. <p>O_AT_END - Set the initial position at the end of the file.</p>

  1647. <p>O_CREAT - If the file exists, this flag has no effect except as noted under O_EXCL below. Otherwise, the file shall be created</p>

  1648. <p>O_EXCL - If O_CREAT and O_EXCL are set, <a class="el" href="class_fat_file.html#a5f64576d3d19177ab3cf3812b69abdfa">open()</a> shall fail if the file exists.</p>

  1649. <p>O_SYNC - Call <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> after each write. This flag should not be used with <a class="el" href="class_fat_file.html#a5524bd9f3b8f54ee163e391cba618186">write(uint8_t)</a> or any functions do character at a time writes since <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> will be called after each byte.</p>

  1650. <p>O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.</p>

  1651. <p>WARNING: A given file must not be opened by more than one <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> object or file corruption may occur.</p>

  1652. <dl class="section note"><dt>Note</dt><dd>Directory files must be opened read only. Write and truncation is not allowed for directory files.</dd></dl>

  1653. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1654. 

  1655. </div>

  1656. </div>

  1657. <a class="anchor" id="ab0e7075062c89f356441f80fc64d03e6"></a>

  1658. <div class="memitem">

  1659. <div class="memproto">

  1660. <table class="mlabels">

  1661.   <tr>

  1662.   <td class="mlabels-left">

  1663.       <table class="memname">

  1664.         <tr>

  1665.           <td class="memname">bool FatFile::open </td>

  1666.           <td>(</td>

  1667.           <td class="paramtype">const char *&#160;</td>

  1668.           <td class="paramname"><em>path</em>, </td>

  1669.         </tr>

  1670.         <tr>

  1671.           <td class="paramkey"></td>

  1672.           <td></td>

  1673.           <td class="paramtype">uint8_t&#160;</td>

  1674.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1675.         </tr>

  1676.         <tr>

  1677.           <td></td>

  1678.           <td>)</td>

  1679.           <td></td><td></td>

  1680.         </tr>

  1681.       </table>

  1682.   </td>

  1683.   <td class="mlabels-right">

  1684. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1685.   </tr>

  1686. </table>

  1687. </div><div class="memdoc">

  1688. <p>Open a file in the current working directory.</p>

  1689. <dl class="params"><dt>Parameters</dt><dd>

  1690.   <table class="params">

  1691.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for a file to be opened.</td></tr>

  1692.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1693.   </table>

  1694.   </dd>

  1695. </dl>

  1696. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1697. 

  1698. </div>

  1699. </div>

  1700. <a class="anchor" id="a8034c4649eb0d26715b1a8a69e73d9d0"></a>

  1701. <div class="memitem">

  1702. <div class="memproto">

  1703.       <table class="memname">

  1704.         <tr>

  1705.           <td class="memname">bool FatFile::openNext </td>

  1706.           <td>(</td>

  1707.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1708.           <td class="paramname"><em>dirFile</em>, </td>

  1709.         </tr>

  1710.         <tr>

  1711.           <td class="paramkey"></td>

  1712.           <td></td>

  1713.           <td class="paramtype">uint8_t&#160;</td>

  1714.           <td class="paramname"><em>oflag</em> = <code>O_READ</code>&#160;</td>

  1715.         </tr>

  1716.         <tr>

  1717.           <td></td>

  1718.           <td>)</td>

  1719.           <td></td><td></td>

  1720.         </tr>

  1721.       </table>

  1722. </div><div class="memdoc">

  1723. <p>Open the next file or subdirectory in a directory.</p>

  1724. <dl class="params"><dt>Parameters</dt><dd>

  1725.   <table class="params">

  1726.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory containing the file to be opened.</td></tr>

  1727.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open mode flags. See see <a class="el" href="class_fat_file.html#a211be757679b18708f6b6a36464e4f61">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1728.   </table>

  1729.   </dd>

  1730. </dl>

  1731. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1732. 

  1733. </div>

  1734. </div>

  1735. <a class="anchor" id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1736. <div class="memitem">

  1737. <div class="memproto">

  1738.       <table class="memname">

  1739.         <tr>

  1740.           <td class="memname">bool FatFile::openRoot </td>

  1741.           <td>(</td>

  1742.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1743.           <td class="paramname"><em>vol</em></td><td>)</td>

  1744.           <td></td>

  1745.         </tr>

  1746.       </table>

  1747. </div><div class="memdoc">

  1748. <p>Open a volume's root directory.</p>

  1749. <dl class="params"><dt>Parameters</dt><dd>

  1750.   <table class="params">

  1751.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1752.   </table>

  1753.   </dd>

  1754. </dl>

  1755. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1756. 

  1757. </div>

  1758. </div>

  1759. <a class="anchor" id="ac05b7136b887539426856c623869aa3a"></a>

  1760. <div class="memitem">

  1761. <div class="memproto">

  1762.       <table class="memname">

  1763.         <tr>

  1764.           <td class="memname">int FatFile::peek </td>

  1765.           <td>(</td>

  1766.           <td class="paramname"></td><td>)</td>

  1767.           <td></td>

  1768.         </tr>

  1769.       </table>

  1770. </div><div class="memdoc">

  1771. <p>Return the next available byte without consuming it.</p>

  1772. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1773. 

  1774. </div>

  1775. </div>

  1776. <a class="anchor" id="a558530f20314a8d8ee3d1a488fc7f46e"></a>

  1777. <div class="memitem">

  1778. <div class="memproto">

  1779.       <table class="memname">

  1780.         <tr>

  1781.           <td class="memname">bool FatFile::printCreateDateTime </td>

  1782.           <td>(</td>

  1783.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1784.           <td class="paramname"><em>pr</em></td><td>)</td>

  1785.           <td></td>

  1786.         </tr>

  1787.       </table>

  1788. </div><div class="memdoc">

  1789. <p>Print a file's creation date and time</p>

  1790. <dl class="params"><dt>Parameters</dt><dd>

  1791.   <table class="params">

  1792.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  1793.   </table>

  1794.   </dd>

  1795. </dl>

  1796. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  1797. 

  1798. </div>

  1799. </div>

  1800. <a class="anchor" id="a8fdb038aafdf3a17ac80b53c063aa73b"></a>

  1801. <div class="memitem">

  1802. <div class="memproto">

  1803. <table class="mlabels">

  1804.   <tr>

  1805.   <td class="mlabels-left">

  1806.       <table class="memname">

  1807.         <tr>

  1808.           <td class="memname">static void FatFile::printFatDate </td>

  1809.           <td>(</td>

  1810.           <td class="paramtype">uint16_t&#160;</td>

  1811.           <td class="paramname"><em>fatDate</em></td><td>)</td>

  1812.           <td></td>

  1813.         </tr>

  1814.       </table>

  1815.   </td>

  1816.   <td class="mlabels-right">

  1817. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  1818.   </tr>

  1819. </table>

  1820. </div><div class="memdoc">

  1821. <p>Print a directory date field.</p>

  1822. <p>Format is yyyy-mm-dd.</p>

  1823. <dl class="params"><dt>Parameters</dt><dd>

  1824.   <table class="params">

  1825.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1826.   </table>

  1827.   </dd>

  1828. </dl>

  1829. 

  1830. </div>

  1831. </div>

  1832. <a class="anchor" id="ada5364f66204b1a64afbf9d2e6cd2b0b"></a>

  1833. <div class="memitem">

  1834. <div class="memproto">

  1835. <table class="mlabels">

  1836.   <tr>

  1837.   <td class="mlabels-left">

  1838.       <table class="memname">

  1839.         <tr>

  1840.           <td class="memname">void FatFile::printFatDate </td>

  1841.           <td>(</td>

  1842.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1843.           <td class="paramname"><em>pr</em>, </td>

  1844.         </tr>

  1845.         <tr>

  1846.           <td class="paramkey"></td>

  1847.           <td></td>

  1848.           <td class="paramtype">uint16_t&#160;</td>

  1849.           <td class="paramname"><em>fatDate</em>&#160;</td>

  1850.         </tr>

  1851.         <tr>

  1852.           <td></td>

  1853.           <td>)</td>

  1854.           <td></td><td></td>

  1855.         </tr>

  1856.       </table>

  1857.   </td>

  1858.   <td class="mlabels-right">

  1859. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  1860.   </tr>

  1861. </table>

  1862. </div><div class="memdoc">

  1863. <p>Print a directory date field.</p>

  1864. <p>Format is yyyy-mm-dd.</p>

  1865. <dl class="params"><dt>Parameters</dt><dd>

  1866.   <table class="params">

  1867.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  1868.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  1869.   </table>

  1870.   </dd>

  1871. </dl>

  1872. 

  1873. </div>

  1874. </div>

  1875. <a class="anchor" id="a7740731f08ef97de7dfbc9b075c4c7d1"></a>

  1876. <div class="memitem">

  1877. <div class="memproto">

  1878. <table class="mlabels">

  1879.   <tr>

  1880.   <td class="mlabels-left">

  1881.       <table class="memname">

  1882.         <tr>

  1883.           <td class="memname">static void FatFile::printFatTime </td>

  1884.           <td>(</td>

  1885.           <td class="paramtype">uint16_t&#160;</td>

  1886.           <td class="paramname"><em>fatTime</em></td><td>)</td>

  1887.           <td></td>

  1888.         </tr>

  1889.       </table>

  1890.   </td>

  1891.   <td class="mlabels-right">

  1892. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  1893.   </tr>

  1894. </table>

  1895. </div><div class="memdoc">

  1896. <p>Print a directory time field.</p>

  1897. <p>Format is hh:mm:ss.</p>

  1898. <dl class="params"><dt>Parameters</dt><dd>

  1899.   <table class="params">

  1900.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  1901.   </table>

  1902.   </dd>

  1903. </dl>

  1904. 

  1905. </div>

  1906. </div>

  1907. <a class="anchor" id="a4e7e56ba52ca17c602af1b85684b09a9"></a>

  1908. <div class="memitem">

  1909. <div class="memproto">

  1910. <table class="mlabels">

  1911.   <tr>

  1912.   <td class="mlabels-left">

  1913.       <table class="memname">

  1914.         <tr>

  1915.           <td class="memname">void FatFile::printFatTime </td>

  1916.           <td>(</td>

  1917.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1918.           <td class="paramname"><em>pr</em>, </td>

  1919.         </tr>

  1920.         <tr>

  1921.           <td class="paramkey"></td>

  1922.           <td></td>

  1923.           <td class="paramtype">uint16_t&#160;</td>

  1924.           <td class="paramname"><em>fatTime</em>&#160;</td>

  1925.         </tr>

  1926.         <tr>

  1927.           <td></td>

  1928.           <td>)</td>

  1929.           <td></td><td></td>

  1930.         </tr>

  1931.       </table>

  1932.   </td>

  1933.   <td class="mlabels-right">

  1934. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  1935.   </tr>

  1936. </table>

  1937. </div><div class="memdoc">

  1938. <p>Print a directory time field.</p>

  1939. <p>Format is hh:mm:ss.</p>

  1940. <dl class="params"><dt>Parameters</dt><dd>

  1941.   <table class="params">

  1942.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  1943.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  1944.   </table>

  1945.   </dd>

  1946. </dl>

  1947. 

  1948. </div>

  1949. </div>

  1950. <a class="anchor" id="a7478cad0f9e5079311b9e1fa558016ff"></a>

  1951. <div class="memitem">

  1952. <div class="memproto">

  1953.       <table class="memname">

  1954.         <tr>

  1955.           <td class="memname">int FatFile::printField </td>

  1956.           <td>(</td>

  1957.           <td class="paramtype">float&#160;</td>

  1958.           <td class="paramname"><em>value</em>, </td>

  1959.         </tr>

  1960.         <tr>

  1961.           <td class="paramkey"></td>

  1962.           <td></td>

  1963.           <td class="paramtype">char&#160;</td>

  1964.           <td class="paramname"><em>term</em>, </td>

  1965.         </tr>

  1966.         <tr>

  1967.           <td class="paramkey"></td>

  1968.           <td></td>

  1969.           <td class="paramtype">uint8_t&#160;</td>

  1970.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  1971.         </tr>

  1972.         <tr>

  1973.           <td></td>

  1974.           <td>)</td>

  1975.           <td></td><td></td>

  1976.         </tr>

  1977.       </table>

  1978. </div><div class="memdoc">

  1979. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  1980.   <table class="params">

  1981.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  1982.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  1983.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  1984.   </table>

  1985.   </dd>

  1986. </dl>

  1987. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  1988. 

  1989. </div>

  1990. </div>

  1991. <a class="anchor" id="abd3e1747511216462b3ef98167156cbb"></a>

  1992. <div class="memitem">

  1993. <div class="memproto">

  1994.       <table class="memname">

  1995.         <tr>

  1996.           <td class="memname">int FatFile::printField </td>

  1997.           <td>(</td>

  1998.           <td class="paramtype">int16_t&#160;</td>

  1999.           <td class="paramname"><em>value</em>, </td>

  2000.         </tr>

  2001.         <tr>

  2002.           <td class="paramkey"></td>

  2003.           <td></td>

  2004.           <td class="paramtype">char&#160;</td>

  2005.           <td class="paramname"><em>term</em>&#160;</td>

  2006.         </tr>

  2007.         <tr>

  2008.           <td></td>

  2009.           <td>)</td>

  2010.           <td></td><td></td>

  2011.         </tr>

  2012.       </table>

  2013. </div><div class="memdoc">

  2014. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2015.   <table class="params">

  2016.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2017.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2018.   </table>

  2019.   </dd>

  2020. </dl>

  2021. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2022. 

  2023. </div>

  2024. </div>

  2025. <a class="anchor" id="a9972c2419c293ef9c382bff666b9ae4d"></a>

  2026. <div class="memitem">

  2027. <div class="memproto">

  2028.       <table class="memname">

  2029.         <tr>

  2030.           <td class="memname">int FatFile::printField </td>

  2031.           <td>(</td>

  2032.           <td class="paramtype">uint16_t&#160;</td>

  2033.           <td class="paramname"><em>value</em>, </td>

  2034.         </tr>

  2035.         <tr>

  2036.           <td class="paramkey"></td>

  2037.           <td></td>

  2038.           <td class="paramtype">char&#160;</td>

  2039.           <td class="paramname"><em>term</em>&#160;</td>

  2040.         </tr>

  2041.         <tr>

  2042.           <td></td>

  2043.           <td>)</td>

  2044.           <td></td><td></td>

  2045.         </tr>

  2046.       </table>

  2047. </div><div class="memdoc">

  2048. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2049.   <table class="params">

  2050.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2051.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2052.   </table>

  2053.   </dd>

  2054. </dl>

  2055. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2056. 

  2057. </div>

  2058. </div>

  2059. <a class="anchor" id="a41b3b32dd8482429b74c7af3432d6cf8"></a>

  2060. <div class="memitem">

  2061. <div class="memproto">

  2062.       <table class="memname">

  2063.         <tr>

  2064.           <td class="memname">int FatFile::printField </td>

  2065.           <td>(</td>

  2066.           <td class="paramtype">int32_t&#160;</td>

  2067.           <td class="paramname"><em>value</em>, </td>

  2068.         </tr>

  2069.         <tr>

  2070.           <td class="paramkey"></td>

  2071.           <td></td>

  2072.           <td class="paramtype">char&#160;</td>

  2073.           <td class="paramname"><em>term</em>&#160;</td>

  2074.         </tr>

  2075.         <tr>

  2076.           <td></td>

  2077.           <td>)</td>

  2078.           <td></td><td></td>

  2079.         </tr>

  2080.       </table>

  2081. </div><div class="memdoc">

  2082. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2083.   <table class="params">

  2084.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2085.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2086.   </table>

  2087.   </dd>

  2088. </dl>

  2089. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2090. 

  2091. </div>

  2092. </div>

  2093. <a class="anchor" id="a097240f08baadeb1c64b63eab9afb088"></a>

  2094. <div class="memitem">

  2095. <div class="memproto">

  2096.       <table class="memname">

  2097.         <tr>

  2098.           <td class="memname">int FatFile::printField </td>

  2099.           <td>(</td>

  2100.           <td class="paramtype">uint32_t&#160;</td>

  2101.           <td class="paramname"><em>value</em>, </td>

  2102.         </tr>

  2103.         <tr>

  2104.           <td class="paramkey"></td>

  2105.           <td></td>

  2106.           <td class="paramtype">char&#160;</td>

  2107.           <td class="paramname"><em>term</em>&#160;</td>

  2108.         </tr>

  2109.         <tr>

  2110.           <td></td>

  2111.           <td>)</td>

  2112.           <td></td><td></td>

  2113.         </tr>

  2114.       </table>

  2115. </div><div class="memdoc">

  2116. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2117.   <table class="params">

  2118.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2119.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2120.   </table>

  2121.   </dd>

  2122. </dl>

  2123. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2124. 

  2125. </div>

  2126. </div>

  2127. <a class="anchor" id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2128. <div class="memitem">

  2129. <div class="memproto">

  2130.       <table class="memname">

  2131.         <tr>

  2132.           <td class="memname">size_t FatFile::printFileSize </td>

  2133.           <td>(</td>

  2134.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2135.           <td class="paramname"><em>pr</em></td><td>)</td>

  2136.           <td></td>

  2137.         </tr>

  2138.       </table>

  2139. </div><div class="memdoc">

  2140. <p>Print a file's size.</p>

  2141. <dl class="params"><dt>Parameters</dt><dd>

  2142.   <table class="params">

  2143.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2144.   </table>

  2145.   </dd>

  2146. </dl>

  2147. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed is returned for success and zero is returned for failure. </dd></dl>

  2148. 

  2149. </div>

  2150. </div>

  2151. <a class="anchor" id="a05cee5df46a370bf916d3ba597c82e39"></a>

  2152. <div class="memitem">

  2153. <div class="memproto">

  2154.       <table class="memname">

  2155.         <tr>

  2156.           <td class="memname">bool FatFile::printModifyDateTime </td>

  2157.           <td>(</td>

  2158.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2159.           <td class="paramname"><em>pr</em></td><td>)</td>

  2160.           <td></td>

  2161.         </tr>

  2162.       </table>

  2163. </div><div class="memdoc">

  2164. <p>Print a file's modify date and time</p>

  2165. <dl class="params"><dt>Parameters</dt><dd>

  2166.   <table class="params">

  2167.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2168.   </table>

  2169.   </dd>

  2170. </dl>

  2171. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2172. 

  2173. </div>

  2174. </div>

  2175. <a class="anchor" id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2176. <div class="memitem">

  2177. <div class="memproto">

  2178. <table class="mlabels">

  2179.   <tr>

  2180.   <td class="mlabels-left">

  2181.       <table class="memname">

  2182.         <tr>

  2183.           <td class="memname">size_t FatFile::printName </td>

  2184.           <td>(</td>

  2185.           <td class="paramname"></td><td>)</td>

  2186.           <td></td>

  2187.         </tr>

  2188.       </table>

  2189.   </td>

  2190.   <td class="mlabels-right">

  2191. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2192.   </tr>

  2193. </table>

  2194. </div><div class="memdoc">

  2195. <p>Print a file's name.</p>

  2196. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2197. 

  2198. </div>

  2199. </div>

  2200. <a class="anchor" id="afe18a787fb8640e2d2483370c770f82f"></a>

  2201. <div class="memitem">

  2202. <div class="memproto">

  2203.       <table class="memname">

  2204.         <tr>

  2205.           <td class="memname">size_t FatFile::printName </td>

  2206.           <td>(</td>

  2207.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2208.           <td class="paramname"><em>pr</em></td><td>)</td>

  2209.           <td></td>

  2210.         </tr>

  2211.       </table>

  2212. </div><div class="memdoc">

  2213. <p>Print a file's name</p>

  2214. <dl class="params"><dt>Parameters</dt><dd>

  2215.   <table class="params">

  2216.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2217.   </table>

  2218.   </dd>

  2219. </dl>

  2220. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2221. 

  2222. </div>

  2223. </div>

  2224. <a class="anchor" id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2225. <div class="memitem">

  2226. <div class="memproto">

  2227.       <table class="memname">

  2228.         <tr>

  2229.           <td class="memname">size_t FatFile::printSFN </td>

  2230.           <td>(</td>

  2231.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2232.           <td class="paramname"><em>pr</em></td><td>)</td>

  2233.           <td></td>

  2234.         </tr>

  2235.       </table>

  2236. </div><div class="memdoc">

  2237. <p>Print a file's Short <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Name.</p>

  2238. <dl class="params"><dt>Parameters</dt><dd>

  2239.   <table class="params">

  2240.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2241.   </table>

  2242.   </dd>

  2243. </dl>

  2244. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed is returned for success and zero is returned for failure. </dd></dl>

  2245. 

  2246. </div>

  2247. </div>

  2248. <a class="anchor" id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2249. <div class="memitem">

  2250. <div class="memproto">

  2251. <table class="mlabels">

  2252.   <tr>

  2253.   <td class="mlabels-left">

  2254.       <table class="memname">

  2255.         <tr>

  2256.           <td class="memname">int FatFile::read </td>

  2257.           <td>(</td>

  2258.           <td class="paramname"></td><td>)</td>

  2259.           <td></td>

  2260.         </tr>

  2261.       </table>

  2262.   </td>

  2263.   <td class="mlabels-right">

  2264. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2265.   </tr>

  2266. </table>

  2267. </div><div class="memdoc">

  2268. <p>Read the next byte from a file.</p>

  2269. <dl class="section return"><dt>Returns</dt><dd>For success read returns the next byte in the file as an int. If an error occurs or end of file is reached -1 is returned. </dd></dl>

  2270. 

  2271. </div>

  2272. </div>

  2273. <a class="anchor" id="a200e6e0553d5b709520c9dfac9ef77dd"></a>

  2274. <div class="memitem">

  2275. <div class="memproto">

  2276.       <table class="memname">

  2277.         <tr>

  2278.           <td class="memname">int FatFile::read </td>

  2279.           <td>(</td>

  2280.           <td class="paramtype">void *&#160;</td>

  2281.           <td class="paramname"><em>buf</em>, </td>

  2282.         </tr>

  2283.         <tr>

  2284.           <td class="paramkey"></td>

  2285.           <td></td>

  2286.           <td class="paramtype">size_t&#160;</td>

  2287.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2288.         </tr>

  2289.         <tr>

  2290.           <td></td>

  2291.           <td>)</td>

  2292.           <td></td><td></td>

  2293.         </tr>

  2294.       </table>

  2295. </div><div class="memdoc">

  2296. <p>Read data from a file starting at the current position.</p>

  2297. <dl class="params"><dt>Parameters</dt><dd>

  2298.   <table class="params">

  2299.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2300.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Maximum number of bytes to read.</td></tr>

  2301.   </table>

  2302.   </dd>

  2303. </dl>

  2304. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> returns the number of bytes read. A value less than <em>nbyte</em>, including zero, will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> called before a file has been opened, corrupt file system or an I/O error occurred. </dd></dl>

  2305. 

  2306. </div>

  2307. </div>

  2308. <a class="anchor" id="a1325afe074c3efecff666678cd9f116a"></a>

  2309. <div class="memitem">

  2310. <div class="memproto">

  2311.       <table class="memname">

  2312.         <tr>

  2313.           <td class="memname">int8_t FatFile::readDir </td>

  2314.           <td>(</td>

  2315.           <td class="paramtype"><a class="el" href="_fat_structs_8h.html#a803db59d4e16a0c54a647afc6a7954e3">dir_t</a> *&#160;</td>

  2316.           <td class="paramname"><em>dir</em></td><td>)</td>

  2317.           <td></td>

  2318.         </tr>

  2319.       </table>

  2320. </div><div class="memdoc">

  2321. <p>Read the next directory entry from a directory file.</p>

  2322. <dl class="params"><dt>Parameters</dt><dd>

  2323.   <table class="params">

  2324.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2325.   </table>

  2326.   </dd>

  2327. </dl>

  2328. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> returns the number of bytes read. A value of zero will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> called before a directory has been opened, this is not a directory file or an I/O error occurred. </dd></dl>

  2329. 

  2330. </div>

  2331. </div>

  2332. <a class="anchor" id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2333. <div class="memitem">

  2334. <div class="memproto">

  2335.       <table class="memname">

  2336.         <tr>

  2337.           <td class="memname">bool FatFile::remove </td>

  2338.           <td>(</td>

  2339.           <td class="paramname"></td><td>)</td>

  2340.           <td></td>

  2341.         </tr>

  2342.       </table>

  2343. </div><div class="memdoc">

  2344. <p>Remove a file.</p>

  2345. <p>The directory entry and all data for the file are deleted.</p>

  2346. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a file that has a long name. For example if a file has the long name "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".</dd></dl>

  2347. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2348. 

  2349. </div>

  2350. </div>

  2351. <a class="anchor" id="afe820bbb056863e91ec482961c8dc695"></a>

  2352. <div class="memitem">

  2353. <div class="memproto">

  2354. <table class="mlabels">

  2355.   <tr>

  2356.   <td class="mlabels-left">

  2357.       <table class="memname">

  2358.         <tr>

  2359.           <td class="memname">bool FatFile::remove </td>

  2360.           <td>(</td>

  2361.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2362.           <td class="paramname"><em>dirFile</em>, </td>

  2363.         </tr>

  2364.         <tr>

  2365.           <td class="paramkey"></td>

  2366.           <td></td>

  2367.           <td class="paramtype">const char *&#160;</td>

  2368.           <td class="paramname"><em>path</em>&#160;</td>

  2369.         </tr>

  2370.         <tr>

  2371.           <td></td>

  2372.           <td>)</td>

  2373.           <td></td><td></td>

  2374.         </tr>

  2375.       </table>

  2376.   </td>

  2377.   <td class="mlabels-right">

  2378. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  2379.   </tr>

  2380. </table>

  2381. </div><div class="memdoc">

  2382. <p>Remove a file.</p>

  2383. <p>The directory entry and all data for the file are deleted.</p>

  2384. <dl class="params"><dt>Parameters</dt><dd>

  2385.   <table class="params">

  2386.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory that contains the file. </td></tr>

  2387.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2388.   </table>

  2389.   </dd>

  2390. </dl>

  2391. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a file that has a long name. For example if a file has the long name "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".</dd></dl>

  2392. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2393. 

  2394. </div>

  2395. </div>

  2396. <a class="anchor" id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2397. <div class="memitem">

  2398. <div class="memproto">

  2399.       <table class="memname">

  2400.         <tr>

  2401.           <td class="memname">bool FatFile::rename </td>

  2402.           <td>(</td>

  2403.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2404.           <td class="paramname"><em>dirFile</em>, </td>

  2405.         </tr>

  2406.         <tr>

  2407.           <td class="paramkey"></td>

  2408.           <td></td>

  2409.           <td class="paramtype">const char *&#160;</td>

  2410.           <td class="paramname"><em>newPath</em>&#160;</td>

  2411.         </tr>

  2412.         <tr>

  2413.           <td></td>

  2414.           <td>)</td>

  2415.           <td></td><td></td>

  2416.         </tr>

  2417.       </table>

  2418. </div><div class="memdoc">

  2419. <p>Rename a file or subdirectory.</p>

  2420. <dl class="params"><dt>Parameters</dt><dd>

  2421.   <table class="params">

  2422.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2423.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2424.   </table>

  2425.   </dd>

  2426. </dl>

  2427. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2428. 

  2429. </div>

  2430. </div>

  2431. <a class="anchor" id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2432. <div class="memitem">

  2433. <div class="memproto">

  2434. <table class="mlabels">

  2435.   <tr>

  2436.   <td class="mlabels-left">

  2437.       <table class="memname">

  2438.         <tr>

  2439.           <td class="memname">void FatFile::rewind </td>

  2440.           <td>(</td>

  2441.           <td class="paramname"></td><td>)</td>

  2442.           <td></td>

  2443.         </tr>

  2444.       </table>

  2445.   </td>

  2446.   <td class="mlabels-right">

  2447. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2448.   </tr>

  2449. </table>

  2450. </div><div class="memdoc">

  2451. <p>Set the file's current position to zero. </p>

  2452. 

  2453. </div>

  2454. </div>

  2455. <a class="anchor" id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2456. <div class="memitem">

  2457. <div class="memproto">

  2458.       <table class="memname">

  2459.         <tr>

  2460.           <td class="memname">bool FatFile::rmdir </td>

  2461.           <td>(</td>

  2462.           <td class="paramname"></td><td>)</td>

  2463.           <td></td>

  2464.         </tr>

  2465.       </table>

  2466. </div><div class="memdoc">

  2467. <p>Remove a directory file.</p>

  2468. <p>The directory file will be removed only if it is empty and is not the root directory. <a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir()</a> follows DOS and Windows and ignores the read-only attribute for the directory.</p>

  2469. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a directory that has a long name. For example if a directory has the long name "New folder" you should not delete the 8.3 name "NEWFOL~1".</dd></dl>

  2470. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2471. 

  2472. </div>

  2473. </div>

  2474. <a class="anchor" id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2475. <div class="memitem">

  2476. <div class="memproto">

  2477.       <table class="memname">

  2478.         <tr>

  2479.           <td class="memname">bool FatFile::rmRfStar </td>

  2480.           <td>(</td>

  2481.           <td class="paramname"></td><td>)</td>

  2482.           <td></td>

  2483.         </tr>

  2484.       </table>

  2485. </div><div class="memdoc">

  2486. <p>Recursively delete a directory and all contained files.</p>

  2487. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2488. <p>Warning - This will remove all contents of the directory including subdirectories. The directory will then be removed if it is not root. The read-only attribute for files will be ignored.</p>

  2489. <dl class="section note"><dt>Note</dt><dd>This function should not be used to delete the 8.3 version of a directory that has a long name. See <a class="el" href="class_fat_file.html#ac837a537fbcca14c7aa390c5fc9f4e7c">remove()</a> and <a class="el" href="class_fat_file.html#a9515bac181d33e7f0125e88fa2ccd283">rmdir()</a>.</dd></dl>

  2490. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2491. 

  2492. </div>

  2493. </div>

  2494. <a class="anchor" id="a5812037ea30777cc350698ad26f2c73f"></a>

  2495. <div class="memitem">

  2496. <div class="memproto">

  2497. <table class="mlabels">

  2498.   <tr>

  2499.   <td class="mlabels-left">

  2500.       <table class="memname">

  2501.         <tr>

  2502.           <td class="memname">bool FatFile::seekCur </td>

  2503.           <td>(</td>

  2504.           <td class="paramtype">int32_t&#160;</td>

  2505.           <td class="paramname"><em>offset</em></td><td>)</td>

  2506.           <td></td>

  2507.         </tr>

  2508.       </table>

  2509.   </td>

  2510.   <td class="mlabels-right">

  2511. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2512.   </tr>

  2513. </table>

  2514. </div><div class="memdoc">

  2515. <p>Set the files position to current position + <em>pos</em>. See <a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet()</a>. </p><dl class="params"><dt>Parameters</dt><dd>

  2516.   <table class="params">

  2517.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2518.   </table>

  2519.   </dd>

  2520. </dl>

  2521. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2522. 

  2523. </div>

  2524. </div>

  2525. <a class="anchor" id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2526. <div class="memitem">

  2527. <div class="memproto">

  2528. <table class="mlabels">

  2529.   <tr>

  2530.   <td class="mlabels-left">

  2531.       <table class="memname">

  2532.         <tr>

  2533.           <td class="memname">bool FatFile::seekEnd </td>

  2534.           <td>(</td>

  2535.           <td class="paramtype">int32_t&#160;</td>

  2536.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2537.           <td></td>

  2538.         </tr>

  2539.       </table>

  2540.   </td>

  2541.   <td class="mlabels-right">

  2542. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2543.   </tr>

  2544. </table>

  2545. </div><div class="memdoc">

  2546. <p>Set the files position to end-of-file + <em>offset</em>. See <a class="el" href="class_fat_file.html#ab067190d25733ed7e697d9890f61fd7a">seekSet()</a>. Can't be used for directory files since file size is not defined. </p><dl class="params"><dt>Parameters</dt><dd>

  2547.   <table class="params">

  2548.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2549.   </table>

  2550.   </dd>

  2551. </dl>

  2552. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2553. 

  2554. </div>

  2555. </div>

  2556. <a class="anchor" id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2557. <div class="memitem">

  2558. <div class="memproto">

  2559.       <table class="memname">

  2560.         <tr>

  2561.           <td class="memname">bool FatFile::seekSet </td>

  2562.           <td>(</td>

  2563.           <td class="paramtype">uint32_t&#160;</td>

  2564.           <td class="paramname"><em>pos</em></td><td>)</td>

  2565.           <td></td>

  2566.         </tr>

  2567.       </table>

  2568. </div><div class="memdoc">

  2569. <p>Sets a file's position.</p>

  2570. <dl class="params"><dt>Parameters</dt><dd>

  2571.   <table class="params">

  2572.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>The new position in bytes from the beginning of the file.</td></tr>

  2573.   </table>

  2574.   </dd>

  2575. </dl>

  2576. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2577. 

  2578. </div>

  2579. </div>

  2580. <a class="anchor" id="a360ef9c05e677271bed6c0a4d663634c"></a>

  2581. <div class="memitem">

  2582. <div class="memproto">

  2583. <table class="mlabels">

  2584.   <tr>

  2585.   <td class="mlabels-left">

  2586.       <table class="memname">

  2587.         <tr>

  2588.           <td class="memname">static bool FatFile::setCwd </td>

  2589.           <td>(</td>

  2590.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2591.           <td class="paramname"><em>dir</em></td><td>)</td>

  2592.           <td></td>

  2593.         </tr>

  2594.       </table>

  2595.   </td>

  2596.   <td class="mlabels-right">

  2597. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>

  2598.   </tr>

  2599. </table>

  2600. </div><div class="memdoc">

  2601. <p>Set the current working directory.</p>

  2602. <dl class="params"><dt>Parameters</dt><dd>

  2603.   <table class="params">

  2604.     <tr><td class="paramdir">[in]</td><td class="paramname">dir</td><td>New current working directory.</td></tr>

  2605.   </table>

  2606.   </dd>

  2607. </dl>

  2608. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2609. 

  2610. </div>

  2611. </div>

  2612. <a class="anchor" id="acf264de4e3ca36c5e8a39e56173c9044"></a>

  2613. <div class="memitem">

  2614. <div class="memproto">

  2615.       <table class="memname">

  2616.         <tr>

  2617.           <td class="memname">void FatFile::setpos </td>

  2618.           <td>(</td>

  2619.           <td class="paramtype"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a> *&#160;</td>

  2620.           <td class="paramname"><em>pos</em></td><td>)</td>

  2621.           <td></td>

  2622.         </tr>

  2623.       </table>

  2624. </div><div class="memdoc">

  2625. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>

  2626.   <table class="params">

  2627.     <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  2628.   </table>

  2629.   </dd>

  2630. </dl>

  2631. 

  2632. </div>

  2633. </div>

  2634. <a class="anchor" id="a67f3dc4896c542d695e11aac927f585e"></a>

  2635. <div class="memitem">

  2636. <div class="memproto">

  2637.       <table class="memname">

  2638.         <tr>

  2639.           <td class="memname">bool FatFile::sync </td>

  2640.           <td>(</td>

  2641.           <td class="paramname"></td><td>)</td>

  2642.           <td></td>

  2643.         </tr>

  2644.       </table>

  2645. </div><div class="memdoc">

  2646. <p>The <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> call causes all modified data and directory fields to be written to the storage device.</p>

  2647. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2648. 

  2649. </div>

  2650. </div>

  2651. <a class="anchor" id="aa53a8d1d2467ad9af7d61cbf8ee85243"></a>

  2652. <div class="memitem">

  2653. <div class="memproto">

  2654.       <table class="memname">

  2655.         <tr>

  2656.           <td class="memname">bool FatFile::timestamp </td>

  2657.           <td>(</td>

  2658.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2659.           <td class="paramname"><em>file</em></td><td>)</td>

  2660.           <td></td>

  2661.         </tr>

  2662.       </table>

  2663. </div><div class="memdoc">

  2664. <p>Copy a file's timestamps</p>

  2665. <dl class="params"><dt>Parameters</dt><dd>

  2666.   <table class="params">

  2667.     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td><a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> to copy timestamps from.</td></tr>

  2668.   </table>

  2669.   </dd>

  2670. </dl>

  2671. <dl class="section note"><dt>Note</dt><dd>Modify and access timestamps may be overwritten if a date time callback function has been set by <a class="el" href="class_fat_file.html#a29a623f50df057e8b49045ba6611ec2b">dateTimeCallback()</a>.</dd></dl>

  2672. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2673. 

  2674. </div>

  2675. </div>

  2676. <a class="anchor" id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2677. <div class="memitem">

  2678. <div class="memproto">

  2679.       <table class="memname">

  2680.         <tr>

  2681.           <td class="memname">bool FatFile::timestamp </td>

  2682.           <td>(</td>

  2683.           <td class="paramtype">uint8_t&#160;</td>

  2684.           <td class="paramname"><em>flags</em>, </td>

  2685.         </tr>

  2686.         <tr>

  2687.           <td class="paramkey"></td>

  2688.           <td></td>

  2689.           <td class="paramtype">uint16_t&#160;</td>

  2690.           <td class="paramname"><em>year</em>, </td>

  2691.         </tr>

  2692.         <tr>

  2693.           <td class="paramkey"></td>

  2694.           <td></td>

  2695.           <td class="paramtype">uint8_t&#160;</td>

  2696.           <td class="paramname"><em>month</em>, </td>

  2697.         </tr>

  2698.         <tr>

  2699.           <td class="paramkey"></td>

  2700.           <td></td>

  2701.           <td class="paramtype">uint8_t&#160;</td>

  2702.           <td class="paramname"><em>day</em>, </td>

  2703.         </tr>

  2704.         <tr>

  2705.           <td class="paramkey"></td>

  2706.           <td></td>

  2707.           <td class="paramtype">uint8_t&#160;</td>

  2708.           <td class="paramname"><em>hour</em>, </td>

  2709.         </tr>

  2710.         <tr>

  2711.           <td class="paramkey"></td>

  2712.           <td></td>

  2713.           <td class="paramtype">uint8_t&#160;</td>

  2714.           <td class="paramname"><em>minute</em>, </td>

  2715.         </tr>

  2716.         <tr>

  2717.           <td class="paramkey"></td>

  2718.           <td></td>

  2719.           <td class="paramtype">uint8_t&#160;</td>

  2720.           <td class="paramname"><em>second</em>&#160;</td>

  2721.         </tr>

  2722.         <tr>

  2723.           <td></td>

  2724.           <td>)</td>

  2725.           <td></td><td></td>

  2726.         </tr>

  2727.       </table>

  2728. </div><div class="memdoc">

  2729. <p>Set a file's timestamps in its directory entry.</p>

  2730. <dl class="params"><dt>Parameters</dt><dd>

  2731.   <table class="params">

  2732.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Values for <em>flags</em> are constructed by a bitwise-inclusive OR of flags from the following list</td></tr>

  2733.   </table>

  2734.   </dd>

  2735. </dl>

  2736. <p>T_ACCESS - Set the file's last access date.</p>

  2737. <p>T_CREATE - Set the file's creation date and time.</p>

  2738. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2739. <dl class="params"><dt>Parameters</dt><dd>

  2740.   <table class="params">

  2741.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2742.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2743.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2744.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2745.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2746.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2747.   </table>

  2748.   </dd>

  2749. </dl>

  2750. <dl class="section note"><dt>Note</dt><dd>It is possible to set an invalid date since there is no check for the number of days in a month.</dd>

  2751. <dd>

  2752. Modify and access timestamps may be overwritten if a date time callback function has been set by <a class="el" href="class_fat_file.html#a29a623f50df057e8b49045ba6611ec2b">dateTimeCallback()</a>.</dd></dl>

  2753. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2754. 

  2755. </div>

  2756. </div>

  2757. <a class="anchor" id="aa6e663098a578635d37d92e82d18d616"></a>

  2758. <div class="memitem">

  2759. <div class="memproto">

  2760.       <table class="memname">

  2761.         <tr>

  2762.           <td class="memname">bool FatFile::truncate </td>

  2763.           <td>(</td>

  2764.           <td class="paramtype">uint32_t&#160;</td>

  2765.           <td class="paramname"><em>length</em></td><td>)</td>

  2766.           <td></td>

  2767.         </tr>

  2768.       </table>

  2769. </div><div class="memdoc">

  2770. <p>Truncate a file to a specified length. The current file position will be maintained if it is less than or equal to <em>length</em> otherwise it will be set to end of file.</p>

  2771. <dl class="params"><dt>Parameters</dt><dd>

  2772.   <table class="params">

  2773.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2774.   </table>

  2775.   </dd>

  2776. </dl>

  2777. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  2778. 

  2779. </div>

  2780. </div>

  2781. <a class="anchor" id="a3c64bd8a9abb9a6461d4addb405614df"></a>

  2782. <div class="memitem">

  2783. <div class="memproto">

  2784. <table class="mlabels">

  2785.   <tr>

  2786.   <td class="mlabels-left">

  2787.       <table class="memname">

  2788.         <tr>

  2789.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFile::volume </td>

  2790.           <td>(</td>

  2791.           <td class="paramname"></td><td>)</td>

  2792.           <td> const</td>

  2793.         </tr>

  2794.       </table>

  2795.   </td>

  2796.   <td class="mlabels-right">

  2797. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2798.   </tr>

  2799. </table>

  2800. </div><div class="memdoc">

  2801. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> that contains this file. </dd></dl>

  2802. 

  2803. </div>

  2804. </div>

  2805. <a class="anchor" id="aa4a5b81161994cea07938702cdfce49f"></a>

  2806. <div class="memitem">

  2807. <div class="memproto">

  2808. <table class="mlabels">

  2809.   <tr>

  2810.   <td class="mlabels-left">

  2811.       <table class="memname">

  2812.         <tr>

  2813.           <td class="memname">int FatFile::write </td>

  2814.           <td>(</td>

  2815.           <td class="paramtype">const char *&#160;</td>

  2816.           <td class="paramname"><em>str</em></td><td>)</td>

  2817.           <td></td>

  2818.         </tr>

  2819.       </table>

  2820.   </td>

  2821.   <td class="mlabels-right">

  2822. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2823.   </tr>

  2824. </table>

  2825. </div><div class="memdoc">

  2826. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2827.   <table class="params">

  2828.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2829.   </table>

  2830.   </dd>

  2831. </dl>

  2832. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2833. 

  2834. </div>

  2835. </div>

  2836. <a class="anchor" id="a5524bd9f3b8f54ee163e391cba618186"></a>

  2837. <div class="memitem">

  2838. <div class="memproto">

  2839. <table class="mlabels">

  2840.   <tr>

  2841.   <td class="mlabels-left">

  2842.       <table class="memname">

  2843.         <tr>

  2844.           <td class="memname">int FatFile::write </td>

  2845.           <td>(</td>

  2846.           <td class="paramtype">uint8_t&#160;</td>

  2847.           <td class="paramname"><em>b</em></td><td>)</td>

  2848.           <td></td>

  2849.         </tr>

  2850.       </table>

  2851.   </td>

  2852.   <td class="mlabels-right">

  2853. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2854.   </tr>

  2855. </table>

  2856. </div><div class="memdoc">

  2857. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2858.   <table class="params">

  2859.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2860.   </table>

  2861.   </dd>

  2862. </dl>

  2863. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  2864. 

  2865. </div>

  2866. </div>

  2867. <a class="anchor" id="a0ab9df44a9ee4b6eb0a78f15f1e30004"></a>

  2868. <div class="memitem">

  2869. <div class="memproto">

  2870.       <table class="memname">

  2871.         <tr>

  2872.           <td class="memname">int FatFile::write </td>

  2873.           <td>(</td>

  2874.           <td class="paramtype">const void *&#160;</td>

  2875.           <td class="paramname"><em>buf</em>, </td>

  2876.         </tr>

  2877.         <tr>

  2878.           <td class="paramkey"></td>

  2879.           <td></td>

  2880.           <td class="paramtype">size_t&#160;</td>

  2881.           <td class="paramname"><em>nbyte</em>&#160;</td>

  2882.         </tr>

  2883.         <tr>

  2884.           <td></td>

  2885.           <td>)</td>

  2886.           <td></td><td></td>

  2887.         </tr>

  2888.       </table>

  2889. </div><div class="memdoc">

  2890. <p>Write data to an open file.</p>

  2891. <dl class="section note"><dt>Note</dt><dd>Data is moved to the cache but may not be written to the storage device until <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> is called.</dd></dl>

  2892. <dl class="params"><dt>Parameters</dt><dd>

  2893.   <table class="params">

  2894.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2895.     <tr><td class="paramdir">[in]</td><td class="paramname">nbyte</td><td>Number of bytes to write.</td></tr>

  2896.   </table>

  2897.   </dd>

  2898. </dl>

  2899. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">write()</a> returns the number of bytes written, always <em>nbyte</em>. If an error occurs, <a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">write()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#aa4a5b81161994cea07938702cdfce49f">write()</a> is called before a file has been opened, write is called for a read-only file, device is full, a corrupt file system or an I/O error. </dd></dl>

  2900. 

  2901. </div>

  2902. </div>

  2903. <hr/>The documentation for this class was generated from the following files:<ul>

  2904. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  2905. <li>Arduino/libraries/SdFat/src/FatLib/FatFile.cpp</li>

  2906. <li>Arduino/libraries/SdFat/src/FatLib/FatFileLFN.cpp</li>

  2907. <li>Arduino/libraries/SdFat/src/FatLib/FatFilePrint.cpp</li>

  2908. <li>Arduino/libraries/SdFat/src/FatLib/FatFileSFN.cpp</li>

  2909. </ul>

  2910. </div><!-- contents -->

  2911. <!-- start footer part -->

  2912. <hr class="footer"/><address class="footer"><small>

  2913. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2914. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2915. </a> 1.8.10

  2916. </small></address>

  2917. </body>

  2918. </html>