visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 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.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/class_fat_file.html

3072 lines
140KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

  32. <!-- Generated by Doxygen 1.8.16 -->

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

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

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

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

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

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

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

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

  67. <a href="#friends">Friends</a> &#124;

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

  69.   <div class="headertitle">

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

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

  72. <div class="contents">

  73. 

  74. <p>Basic file class.  

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

  76. 

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

  78. <div class="dynheader">

  79. Inheritance diagram for FatFile:</div>

  80. <div class="dyncontent">

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

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

  83. <area shape="rect" title="Basic file class." alt="" coords="273,5,336,32"/>

  84. <area shape="rect" href="class_print_file.html" title=" " alt="" coords="5,87,167,114"/>

  85. <area shape="rect" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream." alt="" coords="191,87,285,114"/>

  86. <area shape="rect" href="class_stream_base_class.html" title="base type for FAT and exFAT streams" alt="" coords="309,87,436,114"/>

  87. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="467,80,609,121"/>

  88. <area shape="rect" href="class_sd_file.html" title="FAT16/FAT32 file with Print." alt="" coords="57,169,115,196"/>

  89. <area shape="rect" href="classfstream.html" title="file input/output stream." alt="" coords="243,169,308,196"/>

  90. <area shape="rect" href="classifstream.html" title="file input stream." alt="" coords="332,169,400,196"/>

  91. <area shape="rect" href="classofstream.html" title="file output stream." alt="" coords="425,169,497,196"/>

  92. <area shape="rect" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream." alt="" coords="521,169,579,196"/>

  93. </map>

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

  95. <table class="memberdecls">

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

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

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

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

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

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

  102. <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>

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

  104. <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>

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

  106. <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>

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

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

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

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

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

  112. <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>

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

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

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

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

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

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

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

  120. <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>

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

  122. <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>

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

  124. <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="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint32_t pos, size_t n)</td></tr>

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

  126. <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>

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

  128. <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>

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

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

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

  132. <tr class="memitem:a33e0b0a8a342047f29ab8e8aae9cae14"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a33e0b0a8a342047f29ab8e8aae9cae14">fgetpos</a> (fspos_t *pos)</td></tr>

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

  134. <tr class="memitem:a9e05a51767f7c8f70c6f337eecbdca03"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets</a> (char *str, int num, char *delim=<a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>)</td></tr>

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

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

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

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

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

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

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

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

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

  144. <tr class="memitem:ac042c43d41ecfff4e101b88f3f82086e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ac042c43d41ecfff4e101b88f3f82086e">fsetpos</a> (const fspos_t *pos)</td></tr>

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

  146. <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>

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

  148. <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>

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

  150. <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>

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

  152. <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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  186. <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>

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

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

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

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

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

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

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

  194. <tr class="memitem:af49a42dc64cd954debb271eae5639059"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">open</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol, const char *path, oflag_t oflag)</td></tr>

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

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

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

  198. <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>

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

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

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

  202. <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>

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

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

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

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

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

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

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

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

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

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

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

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

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

  216. <tr class="memitem:a8f906be79086f38943cb0911310d67bf"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>

  217. <tr class="memitem:a8f906be79086f38943cb0911310d67bf"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a8f906be79086f38943cb0911310d67bf">printField</a> (Type value, char term)</td></tr>

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

  219. <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="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

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

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

  223. <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>

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

  225. <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="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  227. <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="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  229. <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>

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

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

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

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

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

  235. <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>

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

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

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

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

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

  241. <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>

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

  243. <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>

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

  245. <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>

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

  247. <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>

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

  249. <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>

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

  251. <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>

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

  253. <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>

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

  255. <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>

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

  257. <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>

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

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

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

  261. <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>

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

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

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

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

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

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

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

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

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

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

  272. <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>

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

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

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

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

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

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

  279. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  280. Friends</h2></td></tr>

  281. <tr class="memitem:a6ca3f436167f187097347a20ea221555"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6ca3f436167f187097347a20ea221555">FatVolume</a></td></tr>

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

  283. </table>

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

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

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

  287. <a id="a7b591c9b92165fa8e4eae8c30c30e533"></a>

  288. <h2 class="memtitle"><span class="permalink"><a href="#a7b591c9b92165fa8e4eae8c30c30e533">&#9670;&nbsp;</a></span>FatFile() <span class="overload">[1/2]</span></h2>

  289. 

  290. <div class="memitem">

  291. <div class="memproto">

  292. <table class="mlabels">

  293.   <tr>

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

  295.       <table class="memname">

  296.         <tr>

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

  298.           <td>(</td>

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

  300.           <td></td>

  301.         </tr>

  302.       </table>

  303.   </td>

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

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

  306.   </tr>

  307. </table>

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

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

  310. 

  311. </div>

  312. </div>

  313. <a id="a38f9a296138648d6135cbbbf41ef6b92"></a>

  314. <h2 class="memtitle"><span class="permalink"><a href="#a38f9a296138648d6135cbbbf41ef6b92">&#9670;&nbsp;</a></span>FatFile() <span class="overload">[2/2]</span></h2>

  315. 

  316. <div class="memitem">

  317. <div class="memproto">

  318. <table class="mlabels">

  319.   <tr>

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

  321.       <table class="memname">

  322.         <tr>

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

  324.           <td>(</td>

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

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

  327.         </tr>

  328.         <tr>

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

  330.           <td></td>

  331.           <td class="paramtype">oflag_t&#160;</td>

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

  333.         </tr>

  334.         <tr>

  335.           <td></td>

  336.           <td>)</td>

  337.           <td></td><td></td>

  338.         </tr>

  339.       </table>

  340.   </td>

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

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

  343.   </tr>

  344. </table>

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

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

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

  348.   <table class="params">

  349.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path for a file to be opened.</td></tr>

  350.     <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#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>. </td></tr>

  351.   </table>

  352.   </dd>

  353. </dl>

  354. 

  355. </div>

  356. </div>

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

  358. <a id="a4baea142c9cd53293a93ef3d6a67aa16"></a>

  359. <h2 class="memtitle"><span class="permalink"><a href="#a4baea142c9cd53293a93ef3d6a67aa16">&#9670;&nbsp;</a></span>available()</h2>

  360. 

  361. <div class="memitem">

  362. <div class="memproto">

  363. <table class="mlabels">

  364.   <tr>

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

  366.       <table class="memname">

  367.         <tr>

  368.           <td class="memname">int FatFile::available </td>

  369.           <td>(</td>

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

  371.           <td></td>

  372.         </tr>

  373.       </table>

  374.   </td>

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

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

  377.   </tr>

  378. </table>

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

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

  381. <p>available64() is recomended for very large files.</p>

  382. <p>Zero is returned for directory files. </p>

  383. 

  384. </div>

  385. </div>

  386. <a id="a651ffa37e7e586fc3c2de8cbbd500ea6"></a>

  387. <h2 class="memtitle"><span class="permalink"><a href="#a651ffa37e7e586fc3c2de8cbbd500ea6">&#9670;&nbsp;</a></span>available32()</h2>

  388. 

  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">uint32_t FatFile::available32 </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. <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>

  409. 

  410. </div>

  411. </div>

  412. <a id="a052e2c15a39b322a5307b693b8835b22"></a>

  413. <h2 class="memtitle"><span class="permalink"><a href="#a052e2c15a39b322a5307b693b8835b22">&#9670;&nbsp;</a></span>clearError()</h2>

  414. 

  415. <div class="memitem">

  416. <div class="memproto">

  417. <table class="mlabels">

  418.   <tr>

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

  420.       <table class="memname">

  421.         <tr>

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

  423.           <td>(</td>

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

  425.           <td></td>

  426.         </tr>

  427.       </table>

  428.   </td>

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

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

  431.   </tr>

  432. </table>

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

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

  435. 

  436. </div>

  437. </div>

  438. <a id="aeca2a2eff91e6aa55fe1b0e3860c9a05"></a>

  439. <h2 class="memtitle"><span class="permalink"><a href="#aeca2a2eff91e6aa55fe1b0e3860c9a05">&#9670;&nbsp;</a></span>clearWriteError()</h2>

  440. 

  441. <div class="memitem">

  442. <div class="memproto">

  443. <table class="mlabels">

  444.   <tr>

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

  446.       <table class="memname">

  447.         <tr>

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

  449.           <td>(</td>

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

  451.           <td></td>

  452.         </tr>

  453.       </table>

  454.   </td>

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

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

  457.   </tr>

  458. </table>

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

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

  461. 

  462. </div>

  463. </div>

  464. <a id="afd16af325e0642e4bff6430b7d8bb18b"></a>

  465. <h2 class="memtitle"><span class="permalink"><a href="#afd16af325e0642e4bff6430b7d8bb18b">&#9670;&nbsp;</a></span>close()</h2>

  466. 

  467. <div class="memitem">

  468. <div class="memproto">

  469.       <table class="memname">

  470.         <tr>

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

  472.           <td>(</td>

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

  474.           <td></td>

  475.         </tr>

  476.       </table>

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

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

  479. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  480. 

  481. </div>

  482. </div>

  483. <a id="a12b3c5a763416ca62c70e3db74033cd0"></a>

  484. <h2 class="memtitle"><span class="permalink"><a href="#a12b3c5a763416ca62c70e3db74033cd0">&#9670;&nbsp;</a></span>contiguousRange()</h2>

  485. 

  486. <div class="memitem">

  487. <div class="memproto">

  488.       <table class="memname">

  489.         <tr>

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

  491.           <td>(</td>

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

  493.           <td class="paramname"><em>bgnSector</em>, </td>

  494.         </tr>

  495.         <tr>

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

  497.           <td></td>

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

  499.           <td class="paramname"><em>endSector</em>&#160;</td>

  500.         </tr>

  501.         <tr>

  502.           <td></td>

  503.           <td>)</td>

  504.           <td></td><td></td>

  505.         </tr>

  506.       </table>

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

  508. <p>Check for contiguous file and return its raw sector range.</p>

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

  510.   <table class="params">

  511.     <tr><td class="paramdir">[out]</td><td class="paramname">bgnSector</td><td>the first sector address for the file. </td></tr>

  512.     <tr><td class="paramdir">[out]</td><td class="paramname">endSector</td><td>the last sector address for the file.</td></tr>

  513.   </table>

  514.   </dd>

  515. </dl>

  516. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  517. 

  518. </div>

  519. </div>

  520. <a id="a0853fbd44aee2798d14d8e3aed78f8bf"></a>

  521. <h2 class="memtitle"><span class="permalink"><a href="#a0853fbd44aee2798d14d8e3aed78f8bf">&#9670;&nbsp;</a></span>createContiguous() <span class="overload">[1/2]</span></h2>

  522. 

  523. <div class="memitem">

  524. <div class="memproto">

  525.       <table class="memname">

  526.         <tr>

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

  528.           <td>(</td>

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

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

  531.         </tr>

  532.         <tr>

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

  534.           <td></td>

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

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

  537.         </tr>

  538.         <tr>

  539.           <td></td>

  540.           <td>)</td>

  541.           <td></td><td></td>

  542.         </tr>

  543.       </table>

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

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

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

  547.   <table class="params">

  548.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a validfile name. </td></tr>

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

  550.   </table>

  551.   </dd>

  552. </dl>

  553. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  554. 

  555. </div>

  556. </div>

  557. <a id="a0afc2a1cffa238d1cb2049bfa2d8d199"></a>

  558. <h2 class="memtitle"><span class="permalink"><a href="#a0afc2a1cffa238d1cb2049bfa2d8d199">&#9670;&nbsp;</a></span>createContiguous() <span class="overload">[2/2]</span></h2>

  559. 

  560. <div class="memitem">

  561. <div class="memproto">

  562.       <table class="memname">

  563.         <tr>

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

  565.           <td>(</td>

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

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

  568.         </tr>

  569.         <tr>

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

  571.           <td></td>

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

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

  574.         </tr>

  575.         <tr>

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

  577.           <td></td>

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

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

  580.         </tr>

  581.         <tr>

  582.           <td></td>

  583.           <td>)</td>

  584.           <td></td><td></td>

  585.         </tr>

  586.       </table>

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

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

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

  590.   <table class="params">

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

  592.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a validfile name. </td></tr>

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

  594.   </table>

  595.   </dd>

  596. </dl>

  597. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  598. 

  599. </div>

  600. </div>

  601. <a id="a526f3dd56ce205690e45ffc86ef6f891"></a>

  602. <h2 class="memtitle"><span class="permalink"><a href="#a526f3dd56ce205690e45ffc86ef6f891">&#9670;&nbsp;</a></span>curCluster()</h2>

  603. 

  604. <div class="memitem">

  605. <div class="memproto">

  606. <table class="mlabels">

  607.   <tr>

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

  609.       <table class="memname">

  610.         <tr>

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

  612.           <td>(</td>

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

  614.           <td> const</td>

  615.         </tr>

  616.       </table>

  617.   </td>

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

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

  620.   </tr>

  621. </table>

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

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

  624. 

  625. </div>

  626. </div>

  627. <a id="a97e0620949f97e9b9c91ed1094d728aa"></a>

  628. <h2 class="memtitle"><span class="permalink"><a href="#a97e0620949f97e9b9c91ed1094d728aa">&#9670;&nbsp;</a></span>curPosition()</h2>

  629. 

  630. <div class="memitem">

  631. <div class="memproto">

  632. <table class="mlabels">

  633.   <tr>

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

  635.       <table class="memname">

  636.         <tr>

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

  638.           <td>(</td>

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

  640.           <td> const</td>

  641.         </tr>

  642.       </table>

  643.   </td>

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

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

  646.   </tr>

  647. </table>

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

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

  650. 

  651. </div>

  652. </div>

  653. <a id="a2f4e9ab3056125b07f15d14ca26d5346"></a>

  654. <h2 class="memtitle"><span class="permalink"><a href="#a2f4e9ab3056125b07f15d14ca26d5346">&#9670;&nbsp;</a></span>dirEntry()</h2>

  655. 

  656. <div class="memitem">

  657. <div class="memproto">

  658.       <table class="memname">

  659.         <tr>

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

  661.           <td>(</td>

  662.           <td class="paramtype">DirFat_t *&#160;</td>

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

  664.           <td></td>

  665.         </tr>

  666.       </table>

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

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

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

  670.   <table class="params">

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

  672.   </table>

  673.   </dd>

  674. </dl>

  675. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  676. 

  677. </div>

  678. </div>

  679. <a id="ae5ec24d4a94d3780384d3f2b731c7eb9"></a>

  680. <h2 class="memtitle"><span class="permalink"><a href="#ae5ec24d4a94d3780384d3f2b731c7eb9">&#9670;&nbsp;</a></span>dirIndex()</h2>

  681. 

  682. <div class="memitem">

  683. <div class="memproto">

  684. <table class="mlabels">

  685.   <tr>

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

  687.       <table class="memname">

  688.         <tr>

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

  690.           <td>(</td>

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

  692.           <td></td>

  693.         </tr>

  694.       </table>

  695.   </td>

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

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

  698.   </tr>

  699. </table>

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

  701. <dl class="section return"><dt>Returns</dt><dd>Directory entry index. </dd></dl>

  702. 

  703. </div>

  704. </div>

  705. <a id="ae2ed15f05c9ccbce355e7a8d3ce8382d"></a>

  706. <h2 class="memtitle"><span class="permalink"><a href="#ae2ed15f05c9ccbce355e7a8d3ce8382d">&#9670;&nbsp;</a></span>dirSize()</h2>

  707. 

  708. <div class="memitem">

  709. <div class="memproto">

  710.       <table class="memname">

  711.         <tr>

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

  713.           <td>(</td>

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

  715.           <td></td>

  716.         </tr>

  717.       </table>

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

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

  720. 

  721. </div>

  722. </div>

  723. <a id="a4f01d27954ae49aeb6888ac7302f55d9"></a>

  724. <h2 class="memtitle"><span class="permalink"><a href="#a4f01d27954ae49aeb6888ac7302f55d9">&#9670;&nbsp;</a></span>dmpFile()</h2>

  725. 

  726. <div class="memitem">

  727. <div class="memproto">

  728.       <table class="memname">

  729.         <tr>

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

  731.           <td>(</td>

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

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

  734.         </tr>

  735.         <tr>

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

  737.           <td></td>

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

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

  740.         </tr>

  741.         <tr>

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

  743.           <td></td>

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

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

  746.         </tr>

  747.         <tr>

  748.           <td></td>

  749.           <td>)</td>

  750.           <td></td><td></td>

  751.         </tr>

  752.       </table>

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

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

  755.   <table class="params">

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

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

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

  759.   </table>

  760.   </dd>

  761. </dl>

  762. 

  763. </div>

  764. </div>

  765. <a id="a50242f98dea0d4488ce4039a279f2a57"></a>

  766. <h2 class="memtitle"><span class="permalink"><a href="#a50242f98dea0d4488ce4039a279f2a57">&#9670;&nbsp;</a></span>exists()</h2>

  767. 

  768. <div class="memitem">

  769. <div class="memproto">

  770. <table class="mlabels">

  771.   <tr>

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

  773.       <table class="memname">

  774.         <tr>

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

  776.           <td>(</td>

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

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

  779.           <td></td>

  780.         </tr>

  781.       </table>

  782.   </td>

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

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

  785.   </tr>

  786. </table>

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

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

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

  790.   <table class="params">

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

  792.   </table>

  793.   </dd>

  794. </dl>

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

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

  797. <dl class="section return"><dt>Returns</dt><dd>True if the file exists. </dd></dl>

  798. 

  799. </div>

  800. </div>

  801. <a id="a33e0b0a8a342047f29ab8e8aae9cae14"></a>

  802. <h2 class="memtitle"><span class="permalink"><a href="#a33e0b0a8a342047f29ab8e8aae9cae14">&#9670;&nbsp;</a></span>fgetpos()</h2>

  803. 

  804. <div class="memitem">

  805. <div class="memproto">

  806.       <table class="memname">

  807.         <tr>

  808.           <td class="memname">void FatFile::fgetpos </td>

  809.           <td>(</td>

  810.           <td class="paramtype">fspos_t *&#160;</td>

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

  812.           <td></td>

  813.         </tr>

  814.       </table>

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

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

  817.   <table class="params">

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

  819.   </table>

  820.   </dd>

  821. </dl>

  822. 

  823. </div>

  824. </div>

  825. <a id="a9e05a51767f7c8f70c6f337eecbdca03"></a>

  826. <h2 class="memtitle"><span class="permalink"><a href="#a9e05a51767f7c8f70c6f337eecbdca03">&#9670;&nbsp;</a></span>fgets()</h2>

  827. 

  828. <div class="memitem">

  829. <div class="memproto">

  830.       <table class="memname">

  831.         <tr>

  832.           <td class="memname">int FatFile::fgets </td>

  833.           <td>(</td>

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

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

  836.         </tr>

  837.         <tr>

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

  839.           <td></td>

  840.           <td class="paramtype">int&#160;</td>

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

  842.         </tr>

  843.         <tr>

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

  845.           <td></td>

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

  847.           <td class="paramname"><em>delim</em> = <code><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code>&#160;</td>

  848.         </tr>

  849.         <tr>

  850.           <td></td>

  851.           <td>)</td>

  852.           <td></td><td></td>

  853.         </tr>

  854.       </table>

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

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

  857. <p><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">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>

  858. <p><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">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>

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

  860.   <table class="params">

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

  862.     <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>

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

  864.   </table>

  865.   </dd>

  866. </dl>

  867. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">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#a9e05a51767f7c8f70c6f337eecbdca03">fgets()</a> returns zero for EOF or -1 if an error occurred. </dd></dl>

  868. 

  869. </div>

  870. </div>

  871. <a id="a874940574b9c99e763526465adf8dc28"></a>

  872. <h2 class="memtitle"><span class="permalink"><a href="#a874940574b9c99e763526465adf8dc28">&#9670;&nbsp;</a></span>fileSize()</h2>

  873. 

  874. <div class="memitem">

  875. <div class="memproto">

  876. <table class="mlabels">

  877.   <tr>

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

  879.       <table class="memname">

  880.         <tr>

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

  882.           <td>(</td>

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

  884.           <td> const</td>

  885.         </tr>

  886.       </table>

  887.   </td>

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

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

  890.   </tr>

  891. </table>

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

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

  894. 

  895. </div>

  896. </div>

  897. <a id="a5ac8a604863d18840f4a93c5c788b7c8"></a>

  898. <h2 class="memtitle"><span class="permalink"><a href="#a5ac8a604863d18840f4a93c5c788b7c8">&#9670;&nbsp;</a></span>firstBlock()</h2>

  899. 

  900. <div class="memitem">

  901. <div class="memproto">

  902. <table class="mlabels">

  903.   <tr>

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

  905.       <table class="memname">

  906.         <tr>

  907.           <td class="memname">uint32_t FatFile::firstBlock </td>

  908.           <td>(</td>

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

  910.           <td> const</td>

  911.         </tr>

  912.       </table>

  913.   </td>

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

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

  916.   </tr>

  917. </table>

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

  919. <dl class="section return"><dt>Returns</dt><dd>first sector of file or zero for empty file. </dd></dl>

  920. 

  921. </div>

  922. </div>

  923. <a id="af3108df387f30ca3d367dd390a04daaa"></a>

  924. <h2 class="memtitle"><span class="permalink"><a href="#af3108df387f30ca3d367dd390a04daaa">&#9670;&nbsp;</a></span>firstSector()</h2>

  925. 

  926. <div class="memitem">

  927. <div class="memproto">

  928.       <table class="memname">

  929.         <tr>

  930.           <td class="memname">uint32_t FatFile::firstSector </td>

  931.           <td>(</td>

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

  933.           <td> const</td>

  934.         </tr>

  935.       </table>

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

  937. <dl class="section return"><dt>Returns</dt><dd>first sector of file or zero for empty file. </dd></dl>

  938. 

  939. </div>

  940. </div>

  941. <a id="a166b5ff04754cc925f2aee71bf92f800"></a>

  942. <h2 class="memtitle"><span class="permalink"><a href="#a166b5ff04754cc925f2aee71bf92f800">&#9670;&nbsp;</a></span>flush()</h2>

  943. 

  944. <div class="memitem">

  945. <div class="memproto">

  946. <table class="mlabels">

  947.   <tr>

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

  949.       <table class="memname">

  950.         <tr>

  951.           <td class="memname">void FatFile::flush </td>

  952.           <td>(</td>

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

  954.           <td></td>

  955.         </tr>

  956.       </table>

  957.   </td>

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

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

  960.   </tr>

  961. </table>

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

  963. <p>Arduino name for <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> </p>

  964. 

  965. </div>

  966. </div>

  967. <a id="ac042c43d41ecfff4e101b88f3f82086e"></a>

  968. <h2 class="memtitle"><span class="permalink"><a href="#ac042c43d41ecfff4e101b88f3f82086e">&#9670;&nbsp;</a></span>fsetpos()</h2>

  969. 

  970. <div class="memitem">

  971. <div class="memproto">

  972.       <table class="memname">

  973.         <tr>

  974.           <td class="memname">void FatFile::fsetpos </td>

  975.           <td>(</td>

  976.           <td class="paramtype">const fspos_t *&#160;</td>

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

  978.           <td></td>

  979.         </tr>

  980.       </table>

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

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

  983.   <table class="params">

  984.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>

  985.   </table>

  986.   </dd>

  987. </dl>

  988. 

  989. </div>

  990. </div>

  991. <a id="ad0dbbd083180f44c7a3ce7124d4ce19c"></a>

  992. <h2 class="memtitle"><span class="permalink"><a href="#ad0dbbd083180f44c7a3ce7124d4ce19c">&#9670;&nbsp;</a></span>getError()</h2>

  993. 

  994. <div class="memitem">

  995. <div class="memproto">

  996. <table class="mlabels">

  997.   <tr>

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

  999.       <table class="memname">

  1000.         <tr>

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

  1002.           <td>(</td>

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

  1004.           <td></td>

  1005.         </tr>

  1006.       </table>

  1007.   </td>

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

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

  1010.   </tr>

  1011. </table>

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

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

  1014. 

  1015. </div>

  1016. </div>

  1017. <a id="aafa565e286440aab612cdb430fc01da5"></a>

  1018. <h2 class="memtitle"><span class="permalink"><a href="#aafa565e286440aab612cdb430fc01da5">&#9670;&nbsp;</a></span>getName()</h2>

  1019. 

  1020. <div class="memitem">

  1021. <div class="memproto">

  1022.       <table class="memname">

  1023.         <tr>

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

  1025.           <td>(</td>

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

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

  1028.         </tr>

  1029.         <tr>

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

  1031.           <td></td>

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

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

  1034.         </tr>

  1035.         <tr>

  1036.           <td></td>

  1037.           <td>)</td>

  1038.           <td></td><td></td>

  1039.         </tr>

  1040.       </table>

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

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

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

  1044.   <table class="params">

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

  1046.     <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>

  1047.   </table>

  1048.   </dd>

  1049. </dl>

  1050. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1051. 

  1052. </div>

  1053. </div>

  1054. <a id="aba30e92a66f8e0d2f815c85662772a58"></a>

  1055. <h2 class="memtitle"><span class="permalink"><a href="#aba30e92a66f8e0d2f815c85662772a58">&#9670;&nbsp;</a></span>getSFN()</h2>

  1056. 

  1057. <div class="memitem">

  1058. <div class="memproto">

  1059.       <table class="memname">

  1060.         <tr>

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

  1062.           <td>(</td>

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

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

  1065.           <td></td>

  1066.         </tr>

  1067.       </table>

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

  1069. <p>Get a file's Short File Name followed by a zero byte.</p>

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

  1071.   <table class="params">

  1072.     <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>

  1073.   </table>

  1074.   </dd>

  1075. </dl>

  1076. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1077. 

  1078. </div>

  1079. </div>

  1080. <a id="a8062c0d3a118e8d77d0310418703d5f5"></a>

  1081. <h2 class="memtitle"><span class="permalink"><a href="#a8062c0d3a118e8d77d0310418703d5f5">&#9670;&nbsp;</a></span>getWriteError()</h2>

  1082. 

  1083. <div class="memitem">

  1084. <div class="memproto">

  1085. <table class="mlabels">

  1086.   <tr>

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

  1088.       <table class="memname">

  1089.         <tr>

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

  1091.           <td>(</td>

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

  1093.           <td></td>

  1094.         </tr>

  1095.       </table>

  1096.   </td>

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

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

  1099.   </tr>

  1100. </table>

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

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

  1103. 

  1104. </div>

  1105. </div>

  1106. <a id="a16478eafdb731e867fb627d19091c3ce"></a>

  1107. <h2 class="memtitle"><span class="permalink"><a href="#a16478eafdb731e867fb627d19091c3ce">&#9670;&nbsp;</a></span>isContiguous()</h2>

  1108. 

  1109. <div class="memitem">

  1110. <div class="memproto">

  1111. <table class="mlabels">

  1112.   <tr>

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

  1114.       <table class="memname">

  1115.         <tr>

  1116.           <td class="memname">bool FatFile::isContiguous </td>

  1117.           <td>(</td>

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

  1119.           <td> const</td>

  1120.         </tr>

  1121.       </table>

  1122.   </td>

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

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

  1125.   </tr>

  1126. </table>

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

  1128. <dl class="section return"><dt>Returns</dt><dd>True if the file is contiguous. </dd></dl>

  1129. 

  1130. </div>

  1131. </div>

  1132. <a id="a933360b20b496421b2bd9ee7a95563a6"></a>

  1133. <h2 class="memtitle"><span class="permalink"><a href="#a933360b20b496421b2bd9ee7a95563a6">&#9670;&nbsp;</a></span>isDir()</h2>

  1134. 

  1135. <div class="memitem">

  1136. <div class="memproto">

  1137. <table class="mlabels">

  1138.   <tr>

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

  1140.       <table class="memname">

  1141.         <tr>

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

  1143.           <td>(</td>

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

  1145.           <td> const</td>

  1146.         </tr>

  1147.       </table>

  1148.   </td>

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

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

  1151.   </tr>

  1152. </table>

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

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

  1155. 

  1156. </div>

  1157. </div>

  1158. <a id="acc5a87da1a5c8cb9758bfeaa7ae47b57"></a>

  1159. <h2 class="memtitle"><span class="permalink"><a href="#acc5a87da1a5c8cb9758bfeaa7ae47b57">&#9670;&nbsp;</a></span>isFile()</h2>

  1160. 

  1161. <div class="memitem">

  1162. <div class="memproto">

  1163. <table class="mlabels">

  1164.   <tr>

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

  1166.       <table class="memname">

  1167.         <tr>

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

  1169.           <td>(</td>

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

  1171.           <td> const</td>

  1172.         </tr>

  1173.       </table>

  1174.   </td>

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

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

  1177.   </tr>

  1178. </table>

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

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

  1181. 

  1182. </div>

  1183. </div>

  1184. <a id="ae216b4a2bc44a9cfb88478fa051a1fd8"></a>

  1185. <h2 class="memtitle"><span class="permalink"><a href="#ae216b4a2bc44a9cfb88478fa051a1fd8">&#9670;&nbsp;</a></span>isHidden()</h2>

  1186. 

  1187. <div class="memitem">

  1188. <div class="memproto">

  1189. <table class="mlabels">

  1190.   <tr>

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

  1192.       <table class="memname">

  1193.         <tr>

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

  1195.           <td>(</td>

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

  1197.           <td> const</td>

  1198.         </tr>

  1199.       </table>

  1200.   </td>

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

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

  1203.   </tr>

  1204. </table>

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

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

  1207. 

  1208. </div>

  1209. </div>

  1210. <a id="af8f456ab790e818bfdd225cf6ffd40f3"></a>

  1211. <h2 class="memtitle"><span class="permalink"><a href="#af8f456ab790e818bfdd225cf6ffd40f3">&#9670;&nbsp;</a></span>isLFN()</h2>

  1212. 

  1213. <div class="memitem">

  1214. <div class="memproto">

  1215. <table class="mlabels">

  1216.   <tr>

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

  1218.       <table class="memname">

  1219.         <tr>

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

  1221.           <td>(</td>

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

  1223.           <td> const</td>

  1224.         </tr>

  1225.       </table>

  1226.   </td>

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

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

  1229.   </tr>

  1230. </table>

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

  1232. <dl class="section return"><dt>Returns</dt><dd>true if this file has a Long File Name. </dd></dl>

  1233. 

  1234. </div>

  1235. </div>

  1236. <a id="a8b8a2850c086d3ce79bee64a23fbf7a6"></a>

  1237. <h2 class="memtitle"><span class="permalink"><a href="#a8b8a2850c086d3ce79bee64a23fbf7a6">&#9670;&nbsp;</a></span>isOpen()</h2>

  1238. 

  1239. <div class="memitem">

  1240. <div class="memproto">

  1241. <table class="mlabels">

  1242.   <tr>

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

  1244.       <table class="memname">

  1245.         <tr>

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

  1247.           <td>(</td>

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

  1249.           <td> const</td>

  1250.         </tr>

  1251.       </table>

  1252.   </td>

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

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

  1255.   </tr>

  1256. </table>

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

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

  1259. 

  1260. </div>

  1261. </div>

  1262. <a id="ae60b4cedb69c88ac641813d5edfa6b4a"></a>

  1263. <h2 class="memtitle"><span class="permalink"><a href="#ae60b4cedb69c88ac641813d5edfa6b4a">&#9670;&nbsp;</a></span>isReadable()</h2>

  1264. 

  1265. <div class="memitem">

  1266. <div class="memproto">

  1267. <table class="mlabels">

  1268.   <tr>

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

  1270.       <table class="memname">

  1271.         <tr>

  1272.           <td class="memname">bool FatFile::isReadable </td>

  1273.           <td>(</td>

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

  1275.           <td> const</td>

  1276.         </tr>

  1277.       </table>

  1278.   </td>

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

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

  1281.   </tr>

  1282. </table>

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

  1284. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>

  1285. 

  1286. </div>

  1287. </div>

  1288. <a id="abaf639ec8f86f34aeb7e6b3615526f0b"></a>

  1289. <h2 class="memtitle"><span class="permalink"><a href="#abaf639ec8f86f34aeb7e6b3615526f0b">&#9670;&nbsp;</a></span>isReadOnly()</h2>

  1290. 

  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::isReadOnly </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 file is read-only </dd></dl>

  1311. 

  1312. </div>

  1313. </div>

  1314. <a id="a03421a0c28649332f55e6ca06d3aeedb"></a>

  1315. <h2 class="memtitle"><span class="permalink"><a href="#a03421a0c28649332f55e6ca06d3aeedb">&#9670;&nbsp;</a></span>isRoot()</h2>

  1316. 

  1317. <div class="memitem">

  1318. <div class="memproto">

  1319. <table class="mlabels">

  1320.   <tr>

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

  1322.       <table class="memname">

  1323.         <tr>

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

  1325.           <td>(</td>

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

  1327.           <td> const</td>

  1328.         </tr>

  1329.       </table>

  1330.   </td>

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

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

  1333.   </tr>

  1334. </table>

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

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

  1337. 

  1338. </div>

  1339. </div>

  1340. <a id="a8fda8004720ec4cc55710869dbb52e35"></a>

  1341. <h2 class="memtitle"><span class="permalink"><a href="#a8fda8004720ec4cc55710869dbb52e35">&#9670;&nbsp;</a></span>isRoot32()</h2>

  1342. 

  1343. <div class="memitem">

  1344. <div class="memproto">

  1345. <table class="mlabels">

  1346.   <tr>

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

  1348.       <table class="memname">

  1349.         <tr>

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

  1351.           <td>(</td>

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

  1353.           <td> const</td>

  1354.         </tr>

  1355.       </table>

  1356.   </td>

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

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

  1359.   </tr>

  1360. </table>

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

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

  1363. 

  1364. </div>

  1365. </div>

  1366. <a id="a0cc65089f7ce6c1ff92edbf0bff59dee"></a>

  1367. <h2 class="memtitle"><span class="permalink"><a href="#a0cc65089f7ce6c1ff92edbf0bff59dee">&#9670;&nbsp;</a></span>isRootFixed()</h2>

  1368. 

  1369. <div class="memitem">

  1370. <div class="memproto">

  1371. <table class="mlabels">

  1372.   <tr>

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

  1374.       <table class="memname">

  1375.         <tr>

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

  1377.           <td>(</td>

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

  1379.           <td> const</td>

  1380.         </tr>

  1381.       </table>

  1382.   </td>

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

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

  1385.   </tr>

  1386. </table>

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

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

  1389. 

  1390. </div>

  1391. </div>

  1392. <a id="abfd02c5d26f7d4f8739a8610116a6660"></a>

  1393. <h2 class="memtitle"><span class="permalink"><a href="#abfd02c5d26f7d4f8739a8610116a6660">&#9670;&nbsp;</a></span>isSubDir()</h2>

  1394. 

  1395. <div class="memitem">

  1396. <div class="memproto">

  1397. <table class="mlabels">

  1398.   <tr>

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

  1400.       <table class="memname">

  1401.         <tr>

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

  1403.           <td>(</td>

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

  1405.           <td> const</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. <dl class="section return"><dt>Returns</dt><dd>True if this is a subdirectory. </dd></dl>

  1415. 

  1416. </div>

  1417. </div>

  1418. <a id="a48087bdeb6b94fc27e0f74c3d90af5a9"></a>

  1419. <h2 class="memtitle"><span class="permalink"><a href="#a48087bdeb6b94fc27e0f74c3d90af5a9">&#9670;&nbsp;</a></span>isSystem()</h2>

  1420. 

  1421. <div class="memitem">

  1422. <div class="memproto">

  1423. <table class="mlabels">

  1424.   <tr>

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

  1426.       <table class="memname">

  1427.         <tr>

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

  1429.           <td>(</td>

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

  1431.           <td> const</td>

  1432.         </tr>

  1433.       </table>

  1434.   </td>

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

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

  1437.   </tr>

  1438. </table>

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

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

  1441. 

  1442. </div>

  1443. </div>

  1444. <a id="aa484d5b2b147c5f3fe0e26b6eaf11ffc"></a>

  1445. <h2 class="memtitle"><span class="permalink"><a href="#aa484d5b2b147c5f3fe0e26b6eaf11ffc">&#9670;&nbsp;</a></span>isWritable()</h2>

  1446. 

  1447. <div class="memitem">

  1448. <div class="memproto">

  1449. <table class="mlabels">

  1450.   <tr>

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

  1452.       <table class="memname">

  1453.         <tr>

  1454.           <td class="memname">bool FatFile::isWritable </td>

  1455.           <td>(</td>

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

  1457.           <td> const</td>

  1458.         </tr>

  1459.       </table>

  1460.   </td>

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

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

  1463.   </tr>

  1464. </table>

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

  1466. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>

  1467. 

  1468. </div>

  1469. </div>

  1470. <a id="a94df8090f16e9666cdc53ca20f6aff90"></a>

  1471. <h2 class="memtitle"><span class="permalink"><a href="#a94df8090f16e9666cdc53ca20f6aff90">&#9670;&nbsp;</a></span>legal83Char()</h2>

  1472. 

  1473. <div class="memitem">

  1474. <div class="memproto">

  1475. <table class="mlabels">

  1476.   <tr>

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

  1478.       <table class="memname">

  1479.         <tr>

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

  1481.           <td>(</td>

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

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

  1484.           <td></td>

  1485.         </tr>

  1486.       </table>

  1487.   </td>

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

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

  1490.   </tr>

  1491. </table>

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

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

  1494.   <table class="params">

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

  1496.   </table>

  1497.   </dd>

  1498. </dl>

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

  1500. 

  1501. </div>

  1502. </div>

  1503. <a id="a60ab9d16bcc778150a364c26de467de1"></a>

  1504. <h2 class="memtitle"><span class="permalink"><a href="#a60ab9d16bcc778150a364c26de467de1">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/2]</span></h2>

  1505. 

  1506. <div class="memitem">

  1507. <div class="memproto">

  1508.       <table class="memname">

  1509.         <tr>

  1510.           <td class="memname">bool FatFile::ls </td>

  1511.           <td>(</td>

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

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

  1514.         </tr>

  1515.         <tr>

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

  1517.           <td></td>

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

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

  1520.         </tr>

  1521.         <tr>

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

  1523.           <td></td>

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

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

  1526.         </tr>

  1527.         <tr>

  1528.           <td></td>

  1529.           <td>)</td>

  1530.           <td></td><td></td>

  1531.         </tr>

  1532.       </table>

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

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

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

  1536.   <table class="params">

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

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

  1539.   </table>

  1540.   </dd>

  1541. </dl>

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

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

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

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

  1546.   <table class="params">

  1547.     <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>

  1548.   </table>

  1549.   </dd>

  1550. </dl>

  1551. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1552. 

  1553. </div>

  1554. </div>

  1555. <a id="a6a11f3307da6232b5f2d11812832d93a"></a>

  1556. <h2 class="memtitle"><span class="permalink"><a href="#a6a11f3307da6232b5f2d11812832d93a">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/2]</span></h2>

  1557. 

  1558. <div class="memitem">

  1559. <div class="memproto">

  1560. <table class="mlabels">

  1561.   <tr>

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

  1563.       <table class="memname">

  1564.         <tr>

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

  1566.           <td>(</td>

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

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

  1569.           <td></td>

  1570.         </tr>

  1571.       </table>

  1572.   </td>

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

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

  1575.   </tr>

  1576. </table>

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

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

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

  1580.   <table class="params">

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

  1582.   </table>

  1583.   </dd>

  1584. </dl>

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

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

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

  1588. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1589. 

  1590. </div>

  1591. </div>

  1592. <a id="abab5b9f72cc796388dd4eed01d13d90d"></a>

  1593. <h2 class="memtitle"><span class="permalink"><a href="#abab5b9f72cc796388dd4eed01d13d90d">&#9670;&nbsp;</a></span>mkdir()</h2>

  1594. 

  1595. <div class="memitem">

  1596. <div class="memproto">

  1597.       <table class="memname">

  1598.         <tr>

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

  1600.           <td>(</td>

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

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

  1603.         </tr>

  1604.         <tr>

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

  1606.           <td></td>

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

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

  1609.         </tr>

  1610.         <tr>

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

  1612.           <td></td>

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

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

  1615.         </tr>

  1616.         <tr>

  1617.           <td></td>

  1618.           <td>)</td>

  1619.           <td></td><td></td>

  1620.         </tr>

  1621.       </table>

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

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

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

  1625.   <table class="params">

  1626.     <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>

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

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

  1629.   </table>

  1630.   </dd>

  1631. </dl>

  1632. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1633. 

  1634. </div>

  1635. </div>

  1636. <a id="afd3e4d5a76b6751ca796fc57f4dd2be4"></a>

  1637. <h2 class="memtitle"><span class="permalink"><a href="#afd3e4d5a76b6751ca796fc57f4dd2be4">&#9670;&nbsp;</a></span>open() <span class="overload">[1/4]</span></h2>

  1638. 

  1639. <div class="memitem">

  1640. <div class="memproto">

  1641.       <table class="memname">

  1642.         <tr>

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

  1644.           <td>(</td>

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

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

  1647.         </tr>

  1648.         <tr>

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

  1650.           <td></td>

  1651.           <td class="paramtype">oflag_t&#160;</td>

  1652.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1653.         </tr>

  1654.         <tr>

  1655.           <td></td>

  1656.           <td>)</td>

  1657.           <td></td><td></td>

  1658.         </tr>

  1659.       </table>

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

  1661. <p>Open a file in the current working volume.</p>

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

  1663.   <table class="params">

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

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

  1666.   </table>

  1667.   </dd>

  1668. </dl>

  1669. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1670. 

  1671. </div>

  1672. </div>

  1673. <a id="a58d6ea245f1bc3ae7a6df311cd25052f"></a>

  1674. <h2 class="memtitle"><span class="permalink"><a href="#a58d6ea245f1bc3ae7a6df311cd25052f">&#9670;&nbsp;</a></span>open() <span class="overload">[2/4]</span></h2>

  1675. 

  1676. <div class="memitem">

  1677. <div class="memproto">

  1678.       <table class="memname">

  1679.         <tr>

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

  1681.           <td>(</td>

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

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

  1684.         </tr>

  1685.         <tr>

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

  1687.           <td></td>

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

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

  1690.         </tr>

  1691.         <tr>

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

  1693.           <td></td>

  1694.           <td class="paramtype">oflag_t&#160;</td>

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

  1696.         </tr>

  1697.         <tr>

  1698.           <td></td>

  1699.           <td>)</td>

  1700.           <td></td><td></td>

  1701.         </tr>

  1702.       </table>

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

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

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

  1706.   <table class="params">

  1707.     <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>

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

  1709.     <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. Only one of O_RDONLY, O_READ, O_WRONLY, O_WRITE, or O_RDWR is allowed.</td></tr>

  1710.   </table>

  1711.   </dd>

  1712. </dl>

  1713. <p>O_RDONLY - Open for reading.</p>

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

  1715. <p>O_WRONLY - Open for writing.</p>

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

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

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

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

  1720. <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>

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

  1722. <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>

  1723. <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>

  1724. <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>

  1725. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1726. 

  1727. </div>

  1728. </div>

  1729. <a id="ab44920bb9cd5414b8e69c9dc4343394a"></a>

  1730. <h2 class="memtitle"><span class="permalink"><a href="#ab44920bb9cd5414b8e69c9dc4343394a">&#9670;&nbsp;</a></span>open() <span class="overload">[3/4]</span></h2>

  1731. 

  1732. <div class="memitem">

  1733. <div class="memproto">

  1734.       <table class="memname">

  1735.         <tr>

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

  1737.           <td>(</td>

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

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

  1740.         </tr>

  1741.         <tr>

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

  1743.           <td></td>

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

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

  1746.         </tr>

  1747.         <tr>

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

  1749.           <td></td>

  1750.           <td class="paramtype">oflag_t&#160;</td>

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

  1752.         </tr>

  1753.         <tr>

  1754.           <td></td>

  1755.           <td>)</td>

  1756.           <td></td><td></td>

  1757.         </tr>

  1758.       </table>

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

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

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

  1762.   <table class="params">

  1763.     <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>

  1764.     <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>

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

  1766.   </table>

  1767.   </dd>

  1768. </dl>

  1769. <p>See <a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">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>

  1770. 

  1771. </div>

  1772. </div>

  1773. <a id="af49a42dc64cd954debb271eae5639059"></a>

  1774. <h2 class="memtitle"><span class="permalink"><a href="#af49a42dc64cd954debb271eae5639059">&#9670;&nbsp;</a></span>open() <span class="overload">[4/4]</span></h2>

  1775. 

  1776. <div class="memitem">

  1777. <div class="memproto">

  1778.       <table class="memname">

  1779.         <tr>

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

  1781.           <td>(</td>

  1782.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1783.           <td class="paramname"><em>vol</em>, </td>

  1784.         </tr>

  1785.         <tr>

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

  1787.           <td></td>

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

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

  1790.         </tr>

  1791.         <tr>

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

  1793.           <td></td>

  1794.           <td class="paramtype">oflag_t&#160;</td>

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

  1796.         </tr>

  1797.         <tr>

  1798.           <td></td>

  1799.           <td>)</td>

  1800.           <td></td><td></td>

  1801.         </tr>

  1802.       </table>

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

  1804. <p>Open a file in the volume root directory.</p>

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

  1806.   <table class="params">

  1807.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>

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

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

  1810.   </table>

  1811.   </dd>

  1812. </dl>

  1813. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1814. 

  1815. </div>

  1816. </div>

  1817. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>

  1818. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>

  1819. 

  1820. <div class="memitem">

  1821. <div class="memproto">

  1822.       <table class="memname">

  1823.         <tr>

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

  1825.           <td>(</td>

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

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

  1828.         </tr>

  1829.         <tr>

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

  1831.           <td></td>

  1832.           <td class="paramtype">oflag_t&#160;</td>

  1833.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1834.         </tr>

  1835.         <tr>

  1836.           <td></td>

  1837.           <td>)</td>

  1838.           <td></td><td></td>

  1839.         </tr>

  1840.       </table>

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

  1842. <p>Open the next file or subdirectory in a directory.</p>

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

  1844.   <table class="params">

  1845.     <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>

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

  1847.   </table>

  1848.   </dd>

  1849. </dl>

  1850. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1851. 

  1852. </div>

  1853. </div>

  1854. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1855. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>

  1856. 

  1857. <div class="memitem">

  1858. <div class="memproto">

  1859.       <table class="memname">

  1860.         <tr>

  1861.           <td class="memname">bool FatFile::openRoot </td>

  1862.           <td>(</td>

  1863.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1864.           <td class="paramname"><em>vol</em></td><td>)</td>

  1865.           <td></td>

  1866.         </tr>

  1867.       </table>

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

  1869. <p>Open a volume's root directory.</p>

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

  1871.   <table class="params">

  1872.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1873.   </table>

  1874.   </dd>

  1875. </dl>

  1876. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1877. 

  1878. </div>

  1879. </div>

  1880. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>

  1881. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>

  1882. 

  1883. <div class="memitem">

  1884. <div class="memproto">

  1885. <table class="mlabels">

  1886.   <tr>

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

  1888.       <table class="memname">

  1889.         <tr>

  1890.           <td class="memname">FatFile::operator bool </td>

  1891.           <td>(</td>

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

  1893.           <td></td>

  1894.         </tr>

  1895.       </table>

  1896.   </td>

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

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

  1899.   </tr>

  1900. </table>

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

  1902. <p>The parenthesis operator.</p>

  1903. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  1904. 

  1905. </div>

  1906. </div>

  1907. <a id="ac05b7136b887539426856c623869aa3a"></a>

  1908. <h2 class="memtitle"><span class="permalink"><a href="#ac05b7136b887539426856c623869aa3a">&#9670;&nbsp;</a></span>peek()</h2>

  1909. 

  1910. <div class="memitem">

  1911. <div class="memproto">

  1912.       <table class="memname">

  1913.         <tr>

  1914.           <td class="memname">int FatFile::peek </td>

  1915.           <td>(</td>

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

  1917.           <td></td>

  1918.         </tr>

  1919.       </table>

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

  1921. <p>Return the next available byte without consuming it.</p>

  1922. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1923. 

  1924. </div>

  1925. </div>

  1926. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>

  1927. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>

  1928. 

  1929. <div class="memitem">

  1930. <div class="memproto">

  1931.       <table class="memname">

  1932.         <tr>

  1933.           <td class="memname">bool FatFile::preAllocate </td>

  1934.           <td>(</td>

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

  1936.           <td class="paramname"><em>length</em></td><td>)</td>

  1937.           <td></td>

  1938.         </tr>

  1939.       </table>

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

  1941. <p>Allocate contiguous clusters to an empty file.</p>

  1942. <p>The file must be empty with no clusters allocated.</p>

  1943. <p>The file will contain uninitialized data.</p>

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

  1945.   <table class="params">

  1946.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  1947.   </table>

  1948.   </dd>

  1949. </dl>

  1950. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1951. 

  1952. </div>

  1953. </div>

  1954. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>

  1955. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>

  1956. 

  1957. <div class="memitem">

  1958. <div class="memproto">

  1959.       <table class="memname">

  1960.         <tr>

  1961.           <td class="memname">size_t FatFile::printAccessDate </td>

  1962.           <td>(</td>

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

  1964.           <td class="paramname"><em>pr</em></td><td>)</td>

  1965.           <td></td>

  1966.         </tr>

  1967.       </table>

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

  1969. <p>Print a file's access date</p>

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

  1971.   <table class="params">

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

  1973.   </table>

  1974.   </dd>

  1975. </dl>

  1976. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  1977. 

  1978. </div>

  1979. </div>

  1980. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>

  1981. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>

  1982. 

  1983. <div class="memitem">

  1984. <div class="memproto">

  1985. <table class="mlabels">

  1986.   <tr>

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

  1988.       <table class="memname">

  1989.         <tr>

  1990.           <td class="memname">size_t FatFile::printAccessDateTime </td>

  1991.           <td>(</td>

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

  1993.           <td class="paramname"><em>pr</em></td><td>)</td>

  1994.           <td></td>

  1995.         </tr>

  1996.       </table>

  1997.   </td>

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

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

  2000.   </tr>

  2001. </table>

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

  2003. <p>Print a file's access date</p>

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

  2005.   <table class="params">

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

  2007.   </table>

  2008.   </dd>

  2009. </dl>

  2010. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2011. 

  2012. </div>

  2013. </div>

  2014. <a id="ab22396a285e27b53501a0047ddd97f59"></a>

  2015. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  2016. 

  2017. <div class="memitem">

  2018. <div class="memproto">

  2019.       <table class="memname">

  2020.         <tr>

  2021.           <td class="memname">size_t FatFile::printCreateDateTime </td>

  2022.           <td>(</td>

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

  2024.           <td class="paramname"><em>pr</em></td><td>)</td>

  2025.           <td></td>

  2026.         </tr>

  2027.       </table>

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

  2029. <p>Print a file's creation date and time</p>

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

  2031.   <table class="params">

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

  2033.   </table>

  2034.   </dd>

  2035. </dl>

  2036. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  2037. 

  2038. </div>

  2039. </div>

  2040. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>

  2041. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>

  2042. 

  2043. <div class="memitem">

  2044. <div class="memproto">

  2045. <table class="mlabels">

  2046.   <tr>

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

  2048.       <table class="memname">

  2049.         <tr>

  2050.           <td class="memname">static void FatFile::printFatDate </td>

  2051.           <td>(</td>

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

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

  2054.         </tr>

  2055.         <tr>

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

  2057.           <td></td>

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

  2059.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2060.         </tr>

  2061.         <tr>

  2062.           <td></td>

  2063.           <td>)</td>

  2064.           <td></td><td></td>

  2065.         </tr>

  2066.       </table>

  2067.   </td>

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

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

  2070.   </tr>

  2071. </table>

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

  2073. <p>Print a directory date field.</p>

  2074. <p>Format is yyyy-mm-dd.</p>

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

  2076.   <table class="params">

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

  2078.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2079.   </table>

  2080.   </dd>

  2081. </dl>

  2082. 

  2083. </div>

  2084. </div>

  2085. <a id="a7f84d953190ea94710dad9ebb897b957"></a>

  2086. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>

  2087. 

  2088. <div class="memitem">

  2089. <div class="memproto">

  2090. <table class="mlabels">

  2091.   <tr>

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

  2093.       <table class="memname">

  2094.         <tr>

  2095.           <td class="memname">static void FatFile::printFatTime </td>

  2096.           <td>(</td>

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

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

  2099.         </tr>

  2100.         <tr>

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

  2102.           <td></td>

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

  2104.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2105.         </tr>

  2106.         <tr>

  2107.           <td></td>

  2108.           <td>)</td>

  2109.           <td></td><td></td>

  2110.         </tr>

  2111.       </table>

  2112.   </td>

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

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

  2115.   </tr>

  2116. </table>

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

  2118. <p>Print a directory time field.</p>

  2119. <p>Format is hh:mm:ss.</p>

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

  2121.   <table class="params">

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

  2123.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2124.   </table>

  2125.   </dd>

  2126. </dl>

  2127. 

  2128. </div>

  2129. </div>

  2130. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>

  2131. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  2132. 

  2133. <div class="memitem">

  2134. <div class="memproto">

  2135. <table class="mlabels">

  2136.   <tr>

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

  2138.       <table class="memname">

  2139.         <tr>

  2140.           <td class="memname">size_t FatFile::printField </td>

  2141.           <td>(</td>

  2142.           <td class="paramtype">double&#160;</td>

  2143.           <td class="paramname"><em>value</em>, </td>

  2144.         </tr>

  2145.         <tr>

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

  2147.           <td></td>

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

  2149.           <td class="paramname"><em>term</em>, </td>

  2150.         </tr>

  2151.         <tr>

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

  2153.           <td></td>

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

  2155.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2156.         </tr>

  2157.         <tr>

  2158.           <td></td>

  2159.           <td>)</td>

  2160.           <td></td><td></td>

  2161.         </tr>

  2162.       </table>

  2163.   </td>

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

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

  2166.   </tr>

  2167. </table>

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

  2169. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2170.   <table class="params">

  2171.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2172.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2173.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2174.   </table>

  2175.   </dd>

  2176. </dl>

  2177. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2178. 

  2179. </div>

  2180. </div>

  2181. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>

  2182. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  2183. 

  2184. <div class="memitem">

  2185. <div class="memproto">

  2186. <table class="mlabels">

  2187.   <tr>

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

  2189.       <table class="memname">

  2190.         <tr>

  2191.           <td class="memname">size_t FatFile::printField </td>

  2192.           <td>(</td>

  2193.           <td class="paramtype">float&#160;</td>

  2194.           <td class="paramname"><em>value</em>, </td>

  2195.         </tr>

  2196.         <tr>

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

  2198.           <td></td>

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

  2200.           <td class="paramname"><em>term</em>, </td>

  2201.         </tr>

  2202.         <tr>

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

  2204.           <td></td>

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

  2206.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2207.         </tr>

  2208.         <tr>

  2209.           <td></td>

  2210.           <td>)</td>

  2211.           <td></td><td></td>

  2212.         </tr>

  2213.       </table>

  2214.   </td>

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

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

  2217.   </tr>

  2218. </table>

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

  2220. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2221.   <table class="params">

  2222.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2223.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2224.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2225.   </table>

  2226.   </dd>

  2227. </dl>

  2228. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2229. 

  2230. </div>

  2231. </div>

  2232. <a id="a8f906be79086f38943cb0911310d67bf"></a>

  2233. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  2234. 

  2235. <div class="memitem">

  2236. <div class="memproto">

  2237. <div class="memtemplate">

  2238. template&lt;typename Type &gt; </div>

  2239. <table class="mlabels">

  2240.   <tr>

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

  2242.       <table class="memname">

  2243.         <tr>

  2244.           <td class="memname">size_t FatFile::printField </td>

  2245.           <td>(</td>

  2246.           <td class="paramtype">Type&#160;</td>

  2247.           <td class="paramname"><em>value</em>, </td>

  2248.         </tr>

  2249.         <tr>

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

  2251.           <td></td>

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

  2253.           <td class="paramname"><em>term</em>&#160;</td>

  2254.         </tr>

  2255.         <tr>

  2256.           <td></td>

  2257.           <td>)</td>

  2258.           <td></td><td></td>

  2259.         </tr>

  2260.       </table>

  2261.   </td>

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

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

  2264.   </tr>

  2265. </table>

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

  2267. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2268.   <table class="params">

  2269.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2270.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2271.   </table>

  2272.   </dd>

  2273. </dl>

  2274. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2275. 

  2276. </div>

  2277. </div>

  2278. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2279. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>

  2280. 

  2281. <div class="memitem">

  2282. <div class="memproto">

  2283.       <table class="memname">

  2284.         <tr>

  2285.           <td class="memname">size_t FatFile::printFileSize </td>

  2286.           <td>(</td>

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

  2288.           <td class="paramname"><em>pr</em></td><td>)</td>

  2289.           <td></td>

  2290.         </tr>

  2291.       </table>

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

  2293. <p>Print a file's size.</p>

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

  2295.   <table class="params">

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

  2297.   </table>

  2298.   </dd>

  2299. </dl>

  2300. <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>

  2301. 

  2302. </div>

  2303. </div>

  2304. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>

  2305. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>

  2306. 

  2307. <div class="memitem">

  2308. <div class="memproto">

  2309.       <table class="memname">

  2310.         <tr>

  2311.           <td class="memname">size_t FatFile::printModifyDateTime </td>

  2312.           <td>(</td>

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

  2314.           <td class="paramname"><em>pr</em></td><td>)</td>

  2315.           <td></td>

  2316.         </tr>

  2317.       </table>

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

  2319. <p>Print a file's modify date and time</p>

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

  2321.   <table class="params">

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

  2323.   </table>

  2324.   </dd>

  2325. </dl>

  2326. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2327. 

  2328. </div>

  2329. </div>

  2330. <a id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2331. <h2 class="memtitle"><span class="permalink"><a href="#ad1cbc3aeb0f5193b7a26595966da9621">&#9670;&nbsp;</a></span>printName() <span class="overload">[1/2]</span></h2>

  2332. 

  2333. <div class="memitem">

  2334. <div class="memproto">

  2335. <table class="mlabels">

  2336.   <tr>

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

  2338.       <table class="memname">

  2339.         <tr>

  2340.           <td class="memname">size_t FatFile::printName </td>

  2341.           <td>(</td>

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

  2343.           <td></td>

  2344.         </tr>

  2345.       </table>

  2346.   </td>

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

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

  2349.   </tr>

  2350. </table>

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

  2352. <p>Print a file's name.</p>

  2353. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2354. 

  2355. </div>

  2356. </div>

  2357. <a id="afe18a787fb8640e2d2483370c770f82f"></a>

  2358. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName() <span class="overload">[2/2]</span></h2>

  2359. 

  2360. <div class="memitem">

  2361. <div class="memproto">

  2362.       <table class="memname">

  2363.         <tr>

  2364.           <td class="memname">size_t FatFile::printName </td>

  2365.           <td>(</td>

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

  2367.           <td class="paramname"><em>pr</em></td><td>)</td>

  2368.           <td></td>

  2369.         </tr>

  2370.       </table>

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

  2372. <p>Print a file's name</p>

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

  2374.   <table class="params">

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

  2376.   </table>

  2377.   </dd>

  2378. </dl>

  2379. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2380. 

  2381. </div>

  2382. </div>

  2383. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2384. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>

  2385. 

  2386. <div class="memitem">

  2387. <div class="memproto">

  2388.       <table class="memname">

  2389.         <tr>

  2390.           <td class="memname">size_t FatFile::printSFN </td>

  2391.           <td>(</td>

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

  2393.           <td class="paramname"><em>pr</em></td><td>)</td>

  2394.           <td></td>

  2395.         </tr>

  2396.       </table>

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

  2398. <p>Print a file's Short File Name.</p>

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

  2400.   <table class="params">

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

  2402.   </table>

  2403.   </dd>

  2404. </dl>

  2405. <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>

  2406. 

  2407. </div>

  2408. </div>

  2409. <a id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2410. <h2 class="memtitle"><span class="permalink"><a href="#a60ae55ff6fe158c2340071d702a363c5">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  2411. 

  2412. <div class="memitem">

  2413. <div class="memproto">

  2414. <table class="mlabels">

  2415.   <tr>

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

  2417.       <table class="memname">

  2418.         <tr>

  2419.           <td class="memname">int FatFile::read </td>

  2420.           <td>(</td>

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

  2422.           <td></td>

  2423.         </tr>

  2424.       </table>

  2425.   </td>

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

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

  2428.   </tr>

  2429. </table>

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

  2431. <p>Read the next byte from a file.</p>

  2432. <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>

  2433. 

  2434. </div>

  2435. </div>

  2436. <a id="aba893af8107a18017482d2311b066187"></a>

  2437. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2438. 

  2439. <div class="memitem">

  2440. <div class="memproto">

  2441.       <table class="memname">

  2442.         <tr>

  2443.           <td class="memname">int FatFile::read </td>

  2444.           <td>(</td>

  2445.           <td class="paramtype">void *&#160;</td>

  2446.           <td class="paramname"><em>buf</em>, </td>

  2447.         </tr>

  2448.         <tr>

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

  2450.           <td></td>

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

  2452.           <td class="paramname"><em>count</em>&#160;</td>

  2453.         </tr>

  2454.         <tr>

  2455.           <td></td>

  2456.           <td>)</td>

  2457.           <td></td><td></td>

  2458.         </tr>

  2459.       </table>

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

  2461. <p>Read data from a file starting at the current position.</p>

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

  2463.   <table class="params">

  2464.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2465.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2466.   </table>

  2467.   </dd>

  2468. </dl>

  2469. <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. </dd></dl>

  2470. 

  2471. </div>

  2472. </div>

  2473. <a id="a29502cd34ef186763d2196daef27df1f"></a>

  2474. <h2 class="memtitle"><span class="permalink"><a href="#a29502cd34ef186763d2196daef27df1f">&#9670;&nbsp;</a></span>readDir()</h2>

  2475. 

  2476. <div class="memitem">

  2477. <div class="memproto">

  2478.       <table class="memname">

  2479.         <tr>

  2480.           <td class="memname">int8_t FatFile::readDir </td>

  2481.           <td>(</td>

  2482.           <td class="paramtype">DirFat_t *&#160;</td>

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

  2484.           <td></td>

  2485.         </tr>

  2486.       </table>

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

  2488. <p>Read the next directory entry from a directory file.</p>

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

  2490.   <table class="params">

  2491.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The DirFat_t struct that will receive the data.</td></tr>

  2492.   </table>

  2493.   </dd>

  2494. </dl>

  2495. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">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#a29502cd34ef186763d2196daef27df1f">readDir()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir()</a> called before a directory has been opened, this is not a directory file or an I/O error occurred. </dd></dl>

  2496. 

  2497. </div>

  2498. </div>

  2499. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2500. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2501. 

  2502. <div class="memitem">

  2503. <div class="memproto">

  2504.       <table class="memname">

  2505.         <tr>

  2506.           <td class="memname">bool FatFile::remove </td>

  2507.           <td>(</td>

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

  2509.           <td></td>

  2510.         </tr>

  2511.       </table>

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

  2513. <p>Remove a file.</p>

  2514. <p>The directory entry and all data for the file are deleted.</p>

  2515. <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>

  2516. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2517. 

  2518. </div>

  2519. </div>

  2520. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>

  2521. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2522. 

  2523. <div class="memitem">

  2524. <div class="memproto">

  2525.       <table class="memname">

  2526.         <tr>

  2527.           <td class="memname">bool FatFile::remove </td>

  2528.           <td>(</td>

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

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

  2531.           <td></td>

  2532.         </tr>

  2533.       </table>

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

  2535. <p>Remove a file.</p>

  2536. <p>The directory entry and all data for the file are deleted.</p>

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

  2538.   <table class="params">

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

  2540.   </table>

  2541.   </dd>

  2542. </dl>

  2543. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2544. <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>

  2545. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2546. 

  2547. </div>

  2548. </div>

  2549. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>

  2550. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2551. 

  2552. <div class="memitem">

  2553. <div class="memproto">

  2554.       <table class="memname">

  2555.         <tr>

  2556.           <td class="memname">bool FatFile::rename </td>

  2557.           <td>(</td>

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

  2559.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2560.           <td></td>

  2561.         </tr>

  2562.       </table>

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

  2564. <p>Rename a file or subdirectory. </p><dl class="section note"><dt>Note</dt><dd>the renamed file will be moved to the current volume working directory.</dd></dl>

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

  2566.   <table class="params">

  2567.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2568.   </table>

  2569.   </dd>

  2570. </dl>

  2571. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2572. 

  2573. </div>

  2574. </div>

  2575. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2576. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2577. 

  2578. <div class="memitem">

  2579. <div class="memproto">

  2580.       <table class="memname">

  2581.         <tr>

  2582.           <td class="memname">bool FatFile::rename </td>

  2583.           <td>(</td>

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

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

  2586.         </tr>

  2587.         <tr>

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

  2589.           <td></td>

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

  2591.           <td class="paramname"><em>newPath</em>&#160;</td>

  2592.         </tr>

  2593.         <tr>

  2594.           <td></td>

  2595.           <td>)</td>

  2596.           <td></td><td></td>

  2597.         </tr>

  2598.       </table>

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

  2600. <p>Rename a file or subdirectory.</p>

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

  2602.   <table class="params">

  2603.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2604.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2605.   </table>

  2606.   </dd>

  2607. </dl>

  2608. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2609. 

  2610. </div>

  2611. </div>

  2612. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2613. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>

  2614. 

  2615. <div class="memitem">

  2616. <div class="memproto">

  2617. <table class="mlabels">

  2618.   <tr>

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

  2620.       <table class="memname">

  2621.         <tr>

  2622.           <td class="memname">void FatFile::rewind </td>

  2623.           <td>(</td>

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

  2625.           <td></td>

  2626.         </tr>

  2627.       </table>

  2628.   </td>

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

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

  2631.   </tr>

  2632. </table>

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

  2634. <p>Set the file's current position to zero. </p>

  2635. 

  2636. </div>

  2637. </div>

  2638. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2639. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>

  2640. 

  2641. <div class="memitem">

  2642. <div class="memproto">

  2643.       <table class="memname">

  2644.         <tr>

  2645.           <td class="memname">bool FatFile::rmdir </td>

  2646.           <td>(</td>

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

  2648.           <td></td>

  2649.         </tr>

  2650.       </table>

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

  2652. <p>Remove a directory file.</p>

  2653. <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>

  2654. <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>

  2655. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2656. 

  2657. </div>

  2658. </div>

  2659. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2660. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>

  2661. 

  2662. <div class="memitem">

  2663. <div class="memproto">

  2664.       <table class="memname">

  2665.         <tr>

  2666.           <td class="memname">bool FatFile::rmRfStar </td>

  2667.           <td>(</td>

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

  2669.           <td></td>

  2670.         </tr>

  2671.       </table>

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

  2673. <p>Recursively delete a directory and all contained files.</p>

  2674. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2675. <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>

  2676. <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>

  2677. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2678. 

  2679. </div>

  2680. </div>

  2681. <a id="a5812037ea30777cc350698ad26f2c73f"></a>

  2682. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>

  2683. 

  2684. <div class="memitem">

  2685. <div class="memproto">

  2686. <table class="mlabels">

  2687.   <tr>

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

  2689.       <table class="memname">

  2690.         <tr>

  2691.           <td class="memname">bool FatFile::seekCur </td>

  2692.           <td>(</td>

  2693.           <td class="paramtype">int32_t&#160;</td>

  2694.           <td class="paramname"><em>offset</em></td><td>)</td>

  2695.           <td></td>

  2696.         </tr>

  2697.       </table>

  2698.   </td>

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

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

  2701.   </tr>

  2702. </table>

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

  2704. <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>

  2705.   <table class="params">

  2706.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2707.   </table>

  2708.   </dd>

  2709. </dl>

  2710. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2711. 

  2712. </div>

  2713. </div>

  2714. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2715. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>

  2716. 

  2717. <div class="memitem">

  2718. <div class="memproto">

  2719. <table class="mlabels">

  2720.   <tr>

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

  2722.       <table class="memname">

  2723.         <tr>

  2724.           <td class="memname">bool FatFile::seekEnd </td>

  2725.           <td>(</td>

  2726.           <td class="paramtype">int32_t&#160;</td>

  2727.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2728.           <td></td>

  2729.         </tr>

  2730.       </table>

  2731.   </td>

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

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

  2734.   </tr>

  2735. </table>

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

  2737. <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>

  2738.   <table class="params">

  2739.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2740.   </table>

  2741.   </dd>

  2742. </dl>

  2743. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2744. 

  2745. </div>

  2746. </div>

  2747. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2748. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>

  2749. 

  2750. <div class="memitem">

  2751. <div class="memproto">

  2752.       <table class="memname">

  2753.         <tr>

  2754.           <td class="memname">bool FatFile::seekSet </td>

  2755.           <td>(</td>

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

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

  2758.           <td></td>

  2759.         </tr>

  2760.       </table>

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

  2762. <p>Sets a file's position.</p>

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

  2764.   <table class="params">

  2765.     <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>

  2766.   </table>

  2767.   </dd>

  2768. </dl>

  2769. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2770. 

  2771. </div>

  2772. </div>

  2773. <a id="a67f3dc4896c542d695e11aac927f585e"></a>

  2774. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>

  2775. 

  2776. <div class="memitem">

  2777. <div class="memproto">

  2778.       <table class="memname">

  2779.         <tr>

  2780.           <td class="memname">bool FatFile::sync </td>

  2781.           <td>(</td>

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

  2783.           <td></td>

  2784.         </tr>

  2785.       </table>

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

  2787. <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>

  2788. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2789. 

  2790. </div>

  2791. </div>

  2792. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2793. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>

  2794. 

  2795. <div class="memitem">

  2796. <div class="memproto">

  2797.       <table class="memname">

  2798.         <tr>

  2799.           <td class="memname">bool FatFile::timestamp </td>

  2800.           <td>(</td>

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

  2802.           <td class="paramname"><em>flags</em>, </td>

  2803.         </tr>

  2804.         <tr>

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

  2806.           <td></td>

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

  2808.           <td class="paramname"><em>year</em>, </td>

  2809.         </tr>

  2810.         <tr>

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

  2812.           <td></td>

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

  2814.           <td class="paramname"><em>month</em>, </td>

  2815.         </tr>

  2816.         <tr>

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

  2818.           <td></td>

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

  2820.           <td class="paramname"><em>day</em>, </td>

  2821.         </tr>

  2822.         <tr>

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

  2824.           <td></td>

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

  2826.           <td class="paramname"><em>hour</em>, </td>

  2827.         </tr>

  2828.         <tr>

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

  2830.           <td></td>

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

  2832.           <td class="paramname"><em>minute</em>, </td>

  2833.         </tr>

  2834.         <tr>

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

  2836.           <td></td>

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

  2838.           <td class="paramname"><em>second</em>&#160;</td>

  2839.         </tr>

  2840.         <tr>

  2841.           <td></td>

  2842.           <td>)</td>

  2843.           <td></td><td></td>

  2844.         </tr>

  2845.       </table>

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

  2847. <p>Set a file's timestamps in its directory entry.</p>

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

  2849.   <table class="params">

  2850.     <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>

  2851.   </table>

  2852.   </dd>

  2853. </dl>

  2854. <p>T_ACCESS - Set the file's last access date.</p>

  2855. <p>T_CREATE - Set the file's creation date and time.</p>

  2856. <p>T_WRITE - Set the file's last write/modification date and time.</p>

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

  2858.   <table class="params">

  2859.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2860.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2861.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2862.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2863.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2864.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2865.   </table>

  2866.   </dd>

  2867. </dl>

  2868. <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>

  2869. <dd>

  2870. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2871. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2872. 

  2873. </div>

  2874. </div>

  2875. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>

  2876. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2877. 

  2878. <div class="memitem">

  2879. <div class="memproto">

  2880.       <table class="memname">

  2881.         <tr>

  2882.           <td class="memname">bool FatFile::truncate </td>

  2883.           <td>(</td>

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

  2885.           <td></td>

  2886.         </tr>

  2887.       </table>

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

  2889. <p>Truncate a file at 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>

  2890. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2891. 

  2892. </div>

  2893. </div>

  2894. <a id="aa6e663098a578635d37d92e82d18d616"></a>

  2895. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2896. 

  2897. <div class="memitem">

  2898. <div class="memproto">

  2899. <table class="mlabels">

  2900.   <tr>

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

  2902.       <table class="memname">

  2903.         <tr>

  2904.           <td class="memname">bool FatFile::truncate </td>

  2905.           <td>(</td>

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

  2907.           <td class="paramname"><em>length</em></td><td>)</td>

  2908.           <td></td>

  2909.         </tr>

  2910.       </table>

  2911.   </td>

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

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

  2914.   </tr>

  2915. </table>

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

  2917. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

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

  2919.   <table class="params">

  2920.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2921.   </table>

  2922.   </dd>

  2923. </dl>

  2924. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2925. 

  2926. </div>

  2927. </div>

  2928. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>

  2929. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  2930. 

  2931. <div class="memitem">

  2932. <div class="memproto">

  2933. <table class="mlabels">

  2934.   <tr>

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

  2936.       <table class="memname">

  2937.         <tr>

  2938.           <td class="memname">size_t FatFile::write </td>

  2939.           <td>(</td>

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

  2941.           <td class="paramname"><em>str</em></td><td>)</td>

  2942.           <td></td>

  2943.         </tr>

  2944.       </table>

  2945.   </td>

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

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

  2948.   </tr>

  2949. </table>

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

  2951. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2952.   <table class="params">

  2953.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2954.   </table>

  2955.   </dd>

  2956. </dl>

  2957. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2958. 

  2959. </div>

  2960. </div>

  2961. <a id="a5d84d871ac904a22aa48308713d14682"></a>

  2962. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  2963. 

  2964. <div class="memitem">

  2965. <div class="memproto">

  2966.       <table class="memname">

  2967.         <tr>

  2968.           <td class="memname">size_t FatFile::write </td>

  2969.           <td>(</td>

  2970.           <td class="paramtype">const void *&#160;</td>

  2971.           <td class="paramname"><em>buf</em>, </td>

  2972.         </tr>

  2973.         <tr>

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

  2975.           <td></td>

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

  2977.           <td class="paramname"><em>count</em>&#160;</td>

  2978.         </tr>

  2979.         <tr>

  2980.           <td></td>

  2981.           <td>)</td>

  2982.           <td></td><td></td>

  2983.         </tr>

  2984.       </table>

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

  2986. <p>Write data to an open file.</p>

  2987. <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>

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

  2989.   <table class="params">

  2990.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2991.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2992.   </table>

  2993.   </dd>

  2994. </dl>

  2995. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write()</a> returns the number of bytes written, always <em>count</em>. If an error occurs, <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">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>

  2996. 

  2997. </div>

  2998. </div>

  2999. <a id="ae51e724ac6cc3d67d64a5a666d5850f1"></a>

  3000. <h2 class="memtitle"><span class="permalink"><a href="#ae51e724ac6cc3d67d64a5a666d5850f1">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  3001. 

  3002. <div class="memitem">

  3003. <div class="memproto">

  3004. <table class="mlabels">

  3005.   <tr>

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

  3007.       <table class="memname">

  3008.         <tr>

  3009.           <td class="memname">size_t FatFile::write </td>

  3010.           <td>(</td>

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

  3012.           <td class="paramname"><em>b</em></td><td>)</td>

  3013.           <td></td>

  3014.         </tr>

  3015.       </table>

  3016.   </td>

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

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

  3019.   </tr>

  3020. </table>

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

  3022. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  3023.   <table class="params">

  3024.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  3025.   </table>

  3026.   </dd>

  3027. </dl>

  3028. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  3029. 

  3030. </div>

  3031. </div>

  3032. <h2 class="groupheader">Friends And Related Function Documentation</h2>

  3033. <a id="a6ca3f436167f187097347a20ea221555"></a>

  3034. <h2 class="memtitle"><span class="permalink"><a href="#a6ca3f436167f187097347a20ea221555">&#9670;&nbsp;</a></span>FatVolume</h2>

  3035. 

  3036. <div class="memitem">

  3037. <div class="memproto">

  3038. <table class="mlabels">

  3039.   <tr>

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

  3041.       <table class="memname">

  3042.         <tr>

  3043.           <td class="memname">friend class <a class="el" href="class_fat_volume.html">FatVolume</a></td>

  3044.         </tr>

  3045.       </table>

  3046.   </td>

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

  3048. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  3049.   </tr>

  3050. </table>

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

  3052. <p><a class="el" href="class_fat_volume.html" title="Integration class for the FatLib library.">FatVolume</a> allowed access to private members. </p>

  3053. 

  3054. </div>

  3055. </div>

  3056. <hr/>The documentation for this class was generated from the following files:<ul>

  3057. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  3058. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFile.cpp</li>

  3059. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFileLFN.cpp</li>

  3060. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFilePrint.cpp</li>

  3061. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFileSFN.cpp</li>

  3062. </ul>

  3063. </div><!-- contents -->

  3064. <!-- start footer part -->

  3065. <hr class="footer"/><address class="footer"><small>

  3066. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3067. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3068. </a> 1.8.16

  3069. </small></address>

  3070. </body>

  3071. </html>