visus
/
teensy-sdfat
Прати 1
Волим 0
Креирај огранак 0
Код Дискусије 0 Захтеви за спајање 0 Издања 0 Вики 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.
53 Комити
1 Грана
Дрво: c980c3e6ec
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from 'c980c3e6ec'
${ noResults }
teensy-sdfat/extras/html/class_fat_file.html

3071 lines
140KB
Датотека Blame Историја 

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

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

  3. <head>

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

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

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

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

  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" id="node2" href="class_print_file.html" title="PrintFile\&lt; SdBaseFile \&gt;" alt="" coords="5,87,167,114"/>

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

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

  86. <area shape="rect" id="node9" href="class_stream_file.html" title="StreamFile\&lt; FatFile,\l uint32_t \&gt;" alt="" coords="467,80,609,121"/>

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

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

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

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

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

  92. </map>

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

  94. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  220. <tr class="memitem: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>

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

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

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

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

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

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

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

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

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

  230. <tr class="memitem: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>

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

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

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

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

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

  236. <tr class="memitem: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  258. <tr class="memitem: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>

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

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

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

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

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

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

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

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

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

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

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

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

  271. <tr class="memitem: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>

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

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

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

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

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

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

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

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

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

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

  282. </table>

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

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

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

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

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

  288. 

  289. <div class="memitem">

  290. <div class="memproto">

  291. <table class="mlabels">

  292.   <tr>

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

  294.       <table class="memname">

  295.         <tr>

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

  297.           <td>(</td>

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

  299.           <td></td>

  300.         </tr>

  301.       </table>

  302.   </td>

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

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

  305.   </tr>

  306. </table>

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

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

  309. 

  310. </div>

  311. </div>

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

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

  314. 

  315. <div class="memitem">

  316. <div class="memproto">

  317. <table class="mlabels">

  318.   <tr>

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

  320.       <table class="memname">

  321.         <tr>

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

  323.           <td>(</td>

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

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

  326.         </tr>

  327.         <tr>

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

  329.           <td></td>

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

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

  332.         </tr>

  333.         <tr>

  334.           <td></td>

  335.           <td>)</td>

  336.           <td></td><td></td>

  337.         </tr>

  338.       </table>

  339.   </td>

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

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

  342.   </tr>

  343. </table>

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

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

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

  347.   <table class="params">

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

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

  350.   </table>

  351.   </dd>

  352. </dl>

  353. 

  354. </div>

  355. </div>

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

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

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

  359. 

  360. <div class="memitem">

  361. <div class="memproto">

  362. <table class="mlabels">

  363.   <tr>

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

  365.       <table class="memname">

  366.         <tr>

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

  368.           <td>(</td>

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

  370.           <td></td>

  371.         </tr>

  372.       </table>

  373.   </td>

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

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

  376.   </tr>

  377. </table>

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

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

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

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

  382. 

  383. </div>

  384. </div>

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

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

  387. 

  388. <div class="memitem">

  389. <div class="memproto">

  390. <table class="mlabels">

  391.   <tr>

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

  393.       <table class="memname">

  394.         <tr>

  395.           <td class="memname">uint32_t FatFile::available32 </td>

  396.           <td>(</td>

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

  398.           <td></td>

  399.         </tr>

  400.       </table>

  401.   </td>

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

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

  404.   </tr>

  405. </table>

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

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

  408. 

  409. </div>

  410. </div>

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

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

  413. 

  414. <div class="memitem">

  415. <div class="memproto">

  416. <table class="mlabels">

  417.   <tr>

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

  419.       <table class="memname">

  420.         <tr>

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

  422.           <td>(</td>

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

  424.           <td></td>

  425.         </tr>

  426.       </table>

  427.   </td>

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

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

  430.   </tr>

  431. </table>

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

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

  434. 

  435. </div>

  436. </div>

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

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

  439. 

  440. <div class="memitem">

  441. <div class="memproto">

  442. <table class="mlabels">

  443.   <tr>

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

  445.       <table class="memname">

  446.         <tr>

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

  448.           <td>(</td>

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

  450.           <td></td>

  451.         </tr>

  452.       </table>

  453.   </td>

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

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

  456.   </tr>

  457. </table>

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

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

  460. 

  461. </div>

  462. </div>

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

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

  465. 

  466. <div class="memitem">

  467. <div class="memproto">

  468.       <table class="memname">

  469.         <tr>

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

  471.           <td>(</td>

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

  473.           <td></td>

  474.         </tr>

  475.       </table>

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

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

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

  479. 

  480. </div>

  481. </div>

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

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

  484. 

  485. <div class="memitem">

  486. <div class="memproto">

  487.       <table class="memname">

  488.         <tr>

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

  490.           <td>(</td>

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

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

  493.         </tr>

  494.         <tr>

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

  496.           <td></td>

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

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

  499.         </tr>

  500.         <tr>

  501.           <td></td>

  502.           <td>)</td>

  503.           <td></td><td></td>

  504.         </tr>

  505.       </table>

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

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

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

  509.   <table class="params">

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

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

  512.   </table>

  513.   </dd>

  514. </dl>

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

  516. 

  517. </div>

  518. </div>

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

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

  521. 

  522. <div class="memitem">

  523. <div class="memproto">

  524.       <table class="memname">

  525.         <tr>

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

  527.           <td>(</td>

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

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

  530.         </tr>

  531.         <tr>

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

  533.           <td></td>

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

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

  536.         </tr>

  537.         <tr>

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

  539.           <td></td>

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

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

  542.         </tr>

  543.         <tr>

  544.           <td></td>

  545.           <td>)</td>

  546.           <td></td><td></td>

  547.         </tr>

  548.       </table>

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

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

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

  552.   <table class="params">

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

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

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

  556.   </table>

  557.   </dd>

  558. </dl>

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

  560. 

  561. </div>

  562. </div>

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

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

  565. 

  566. <div class="memitem">

  567. <div class="memproto">

  568.       <table class="memname">

  569.         <tr>

  570.           <td class="memname">bool FatFile::createContiguous </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">path</td><td>A path with a validfile name. </td></tr>

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

  593.   </table>

  594.   </dd>

  595. </dl>

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

  597. 

  598. </div>

  599. </div>

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

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

  602. 

  603. <div class="memitem">

  604. <div class="memproto">

  605. <table class="mlabels">

  606.   <tr>

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

  608.       <table class="memname">

  609.         <tr>

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

  611.           <td>(</td>

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

  613.           <td> const</td>

  614.         </tr>

  615.       </table>

  616.   </td>

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

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

  619.   </tr>

  620. </table>

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

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

  623. 

  624. </div>

  625. </div>

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

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

  628. 

  629. <div class="memitem">

  630. <div class="memproto">

  631. <table class="mlabels">

  632.   <tr>

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

  634.       <table class="memname">

  635.         <tr>

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

  637.           <td>(</td>

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

  639.           <td> const</td>

  640.         </tr>

  641.       </table>

  642.   </td>

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

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

  645.   </tr>

  646. </table>

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

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

  649. 

  650. </div>

  651. </div>

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

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

  654. 

  655. <div class="memitem">

  656. <div class="memproto">

  657.       <table class="memname">

  658.         <tr>

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

  660.           <td>(</td>

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

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

  663.           <td></td>

  664.         </tr>

  665.       </table>

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

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

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

  669.   <table class="params">

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

  671.   </table>

  672.   </dd>

  673. </dl>

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

  675. 

  676. </div>

  677. </div>

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

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

  680. 

  681. <div class="memitem">

  682. <div class="memproto">

  683. <table class="mlabels">

  684.   <tr>

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

  686.       <table class="memname">

  687.         <tr>

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

  689.           <td>(</td>

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

  691.           <td></td>

  692.         </tr>

  693.       </table>

  694.   </td>

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

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

  697.   </tr>

  698. </table>

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

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

  701. 

  702. </div>

  703. </div>

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

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

  706. 

  707. <div class="memitem">

  708. <div class="memproto">

  709.       <table class="memname">

  710.         <tr>

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

  712.           <td>(</td>

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

  714.           <td></td>

  715.         </tr>

  716.       </table>

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

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

  719. 

  720. </div>

  721. </div>

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

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

  724. 

  725. <div class="memitem">

  726. <div class="memproto">

  727.       <table class="memname">

  728.         <tr>

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

  730.           <td>(</td>

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

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

  733.         </tr>

  734.         <tr>

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

  736.           <td></td>

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

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

  739.         </tr>

  740.         <tr>

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

  742.           <td></td>

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

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

  745.         </tr>

  746.         <tr>

  747.           <td></td>

  748.           <td>)</td>

  749.           <td></td><td></td>

  750.         </tr>

  751.       </table>

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

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

  754.   <table class="params">

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

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

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

  758.   </table>

  759.   </dd>

  760. </dl>

  761. 

  762. </div>

  763. </div>

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

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

  766. 

  767. <div class="memitem">

  768. <div class="memproto">

  769. <table class="mlabels">

  770.   <tr>

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

  772.       <table class="memname">

  773.         <tr>

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

  775.           <td>(</td>

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

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

  778.           <td></td>

  779.         </tr>

  780.       </table>

  781.   </td>

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

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

  784.   </tr>

  785. </table>

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

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

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

  789.   <table class="params">

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

  791.   </table>

  792.   </dd>

  793. </dl>

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

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

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

  797. 

  798. </div>

  799. </div>

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

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

  802. 

  803. <div class="memitem">

  804. <div class="memproto">

  805.       <table class="memname">

  806.         <tr>

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

  808.           <td>(</td>

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

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

  811.           <td></td>

  812.         </tr>

  813.       </table>

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

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

  816.   <table class="params">

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

  818.   </table>

  819.   </dd>

  820. </dl>

  821. 

  822. </div>

  823. </div>

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

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

  826. 

  827. <div class="memitem">

  828. <div class="memproto">

  829.       <table class="memname">

  830.         <tr>

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

  832.           <td>(</td>

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

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

  835.         </tr>

  836.         <tr>

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

  838.           <td></td>

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

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

  841.         </tr>

  842.         <tr>

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

  844.           <td></td>

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

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

  847.         </tr>

  848.         <tr>

  849.           <td></td>

  850.           <td>)</td>

  851.           <td></td><td></td>

  852.         </tr>

  853.       </table>

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

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

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

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

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

  859.   <table class="params">

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

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

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

  863.   </table>

  864.   </dd>

  865. </dl>

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

  867. 

  868. </div>

  869. </div>

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

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

  872. 

  873. <div class="memitem">

  874. <div class="memproto">

  875. <table class="mlabels">

  876.   <tr>

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

  878.       <table class="memname">

  879.         <tr>

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

  881.           <td>(</td>

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

  883.           <td> const</td>

  884.         </tr>

  885.       </table>

  886.   </td>

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

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

  889.   </tr>

  890. </table>

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

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

  893. 

  894. </div>

  895. </div>

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

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

  898. 

  899. <div class="memitem">

  900. <div class="memproto">

  901. <table class="mlabels">

  902.   <tr>

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

  904.       <table class="memname">

  905.         <tr>

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

  907.           <td>(</td>

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

  909.           <td> const</td>

  910.         </tr>

  911.       </table>

  912.   </td>

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

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

  915.   </tr>

  916. </table>

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

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

  919. 

  920. </div>

  921. </div>

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

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

  924. 

  925. <div class="memitem">

  926. <div class="memproto">

  927.       <table class="memname">

  928.         <tr>

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

  930.           <td>(</td>

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

  932.           <td> const</td>

  933.         </tr>

  934.       </table>

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

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

  937. 

  938. </div>

  939. </div>

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

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

  942. 

  943. <div class="memitem">

  944. <div class="memproto">

  945. <table class="mlabels">

  946.   <tr>

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

  948.       <table class="memname">

  949.         <tr>

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

  951.           <td>(</td>

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

  953.           <td></td>

  954.         </tr>

  955.       </table>

  956.   </td>

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

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

  959.   </tr>

  960. </table>

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

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

  963. 

  964. </div>

  965. </div>

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

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

  968. 

  969. <div class="memitem">

  970. <div class="memproto">

  971.       <table class="memname">

  972.         <tr>

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

  974.           <td>(</td>

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

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

  977.           <td></td>

  978.         </tr>

  979.       </table>

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

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

  982.   <table class="params">

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

  984.   </table>

  985.   </dd>

  986. </dl>

  987. 

  988. </div>

  989. </div>

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

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

  992. 

  993. <div class="memitem">

  994. <div class="memproto">

  995. <table class="mlabels">

  996.   <tr>

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

  998.       <table class="memname">

  999.         <tr>

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

  1001.           <td>(</td>

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

  1003.           <td></td>

  1004.         </tr>

  1005.       </table>

  1006.   </td>

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

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

  1009.   </tr>

  1010. </table>

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

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

  1013. 

  1014. </div>

  1015. </div>

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

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

  1018. 

  1019. <div class="memitem">

  1020. <div class="memproto">

  1021.       <table class="memname">

  1022.         <tr>

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

  1024.           <td>(</td>

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

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

  1027.         </tr>

  1028.         <tr>

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

  1030.           <td></td>

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

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

  1033.         </tr>

  1034.         <tr>

  1035.           <td></td>

  1036.           <td>)</td>

  1037.           <td></td><td></td>

  1038.         </tr>

  1039.       </table>

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

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

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

  1043.   <table class="params">

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

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

  1046.   </table>

  1047.   </dd>

  1048. </dl>

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

  1050. 

  1051. </div>

  1052. </div>

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

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

  1055. 

  1056. <div class="memitem">

  1057. <div class="memproto">

  1058.       <table class="memname">

  1059.         <tr>

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

  1061.           <td>(</td>

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

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

  1064.           <td></td>

  1065.         </tr>

  1066.       </table>

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

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

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

  1070.   <table class="params">

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

  1072.   </table>

  1073.   </dd>

  1074. </dl>

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

  1076. 

  1077. </div>

  1078. </div>

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

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

  1081. 

  1082. <div class="memitem">

  1083. <div class="memproto">

  1084. <table class="mlabels">

  1085.   <tr>

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

  1087.       <table class="memname">

  1088.         <tr>

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

  1090.           <td>(</td>

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

  1092.           <td></td>

  1093.         </tr>

  1094.       </table>

  1095.   </td>

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

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

  1098.   </tr>

  1099. </table>

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

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

  1102. 

  1103. </div>

  1104. </div>

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

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

  1107. 

  1108. <div class="memitem">

  1109. <div class="memproto">

  1110. <table class="mlabels">

  1111.   <tr>

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

  1113.       <table class="memname">

  1114.         <tr>

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

  1116.           <td>(</td>

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

  1118.           <td> const</td>

  1119.         </tr>

  1120.       </table>

  1121.   </td>

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

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

  1124.   </tr>

  1125. </table>

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

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

  1128. 

  1129. </div>

  1130. </div>

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

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

  1133. 

  1134. <div class="memitem">

  1135. <div class="memproto">

  1136. <table class="mlabels">

  1137.   <tr>

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

  1139.       <table class="memname">

  1140.         <tr>

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

  1142.           <td>(</td>

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

  1144.           <td> const</td>

  1145.         </tr>

  1146.       </table>

  1147.   </td>

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

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

  1150.   </tr>

  1151. </table>

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

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

  1154. 

  1155. </div>

  1156. </div>

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

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

  1159. 

  1160. <div class="memitem">

  1161. <div class="memproto">

  1162. <table class="mlabels">

  1163.   <tr>

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

  1165.       <table class="memname">

  1166.         <tr>

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

  1168.           <td>(</td>

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

  1170.           <td> const</td>

  1171.         </tr>

  1172.       </table>

  1173.   </td>

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

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

  1176.   </tr>

  1177. </table>

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

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

  1180. 

  1181. </div>

  1182. </div>

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

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

  1185. 

  1186. <div class="memitem">

  1187. <div class="memproto">

  1188. <table class="mlabels">

  1189.   <tr>

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

  1191.       <table class="memname">

  1192.         <tr>

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

  1194.           <td>(</td>

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

  1196.           <td> const</td>

  1197.         </tr>

  1198.       </table>

  1199.   </td>

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

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

  1202.   </tr>

  1203. </table>

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

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

  1206. 

  1207. </div>

  1208. </div>

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

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

  1211. 

  1212. <div class="memitem">

  1213. <div class="memproto">

  1214. <table class="mlabels">

  1215.   <tr>

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

  1217.       <table class="memname">

  1218.         <tr>

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

  1220.           <td>(</td>

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

  1222.           <td> const</td>

  1223.         </tr>

  1224.       </table>

  1225.   </td>

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

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

  1228.   </tr>

  1229. </table>

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

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

  1232. 

  1233. </div>

  1234. </div>

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

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

  1237. 

  1238. <div class="memitem">

  1239. <div class="memproto">

  1240. <table class="mlabels">

  1241.   <tr>

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

  1243.       <table class="memname">

  1244.         <tr>

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

  1246.           <td>(</td>

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

  1248.           <td> const</td>

  1249.         </tr>

  1250.       </table>

  1251.   </td>

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

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

  1254.   </tr>

  1255. </table>

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

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

  1258. 

  1259. </div>

  1260. </div>

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

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

  1263. 

  1264. <div class="memitem">

  1265. <div class="memproto">

  1266. <table class="mlabels">

  1267.   <tr>

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

  1269.       <table class="memname">

  1270.         <tr>

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

  1272.           <td>(</td>

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

  1274.           <td> const</td>

  1275.         </tr>

  1276.       </table>

  1277.   </td>

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

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

  1280.   </tr>

  1281. </table>

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

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

  1284. 

  1285. </div>

  1286. </div>

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

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

  1289. 

  1290. <div class="memitem">

  1291. <div class="memproto">

  1292. <table class="mlabels">

  1293.   <tr>

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

  1295.       <table class="memname">

  1296.         <tr>

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

  1298.           <td>(</td>

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

  1300.           <td> const</td>

  1301.         </tr>

  1302.       </table>

  1303.   </td>

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

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

  1306.   </tr>

  1307. </table>

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

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

  1310. 

  1311. </div>

  1312. </div>

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

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

  1315. 

  1316. <div class="memitem">

  1317. <div class="memproto">

  1318. <table class="mlabels">

  1319.   <tr>

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

  1321.       <table class="memname">

  1322.         <tr>

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

  1324.           <td>(</td>

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

  1326.           <td> const</td>

  1327.         </tr>

  1328.       </table>

  1329.   </td>

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

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

  1332.   </tr>

  1333. </table>

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

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

  1336. 

  1337. </div>

  1338. </div>

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

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

  1341. 

  1342. <div class="memitem">

  1343. <div class="memproto">

  1344. <table class="mlabels">

  1345.   <tr>

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

  1347.       <table class="memname">

  1348.         <tr>

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

  1350.           <td>(</td>

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

  1352.           <td> const</td>

  1353.         </tr>

  1354.       </table>

  1355.   </td>

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

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

  1358.   </tr>

  1359. </table>

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

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

  1362. 

  1363. </div>

  1364. </div>

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

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

  1367. 

  1368. <div class="memitem">

  1369. <div class="memproto">

  1370. <table class="mlabels">

  1371.   <tr>

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

  1373.       <table class="memname">

  1374.         <tr>

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

  1376.           <td>(</td>

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

  1378.           <td> const</td>

  1379.         </tr>

  1380.       </table>

  1381.   </td>

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

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

  1384.   </tr>

  1385. </table>

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

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

  1388. 

  1389. </div>

  1390. </div>

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

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

  1393. 

  1394. <div class="memitem">

  1395. <div class="memproto">

  1396. <table class="mlabels">

  1397.   <tr>

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

  1399.       <table class="memname">

  1400.         <tr>

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

  1402.           <td>(</td>

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

  1404.           <td> const</td>

  1405.         </tr>

  1406.       </table>

  1407.   </td>

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

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

  1410.   </tr>

  1411. </table>

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

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

  1414. 

  1415. </div>

  1416. </div>

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

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

  1419. 

  1420. <div class="memitem">

  1421. <div class="memproto">

  1422. <table class="mlabels">

  1423.   <tr>

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

  1425.       <table class="memname">

  1426.         <tr>

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

  1428.           <td>(</td>

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

  1430.           <td> const</td>

  1431.         </tr>

  1432.       </table>

  1433.   </td>

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

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

  1436.   </tr>

  1437. </table>

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

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

  1440. 

  1441. </div>

  1442. </div>

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

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

  1445. 

  1446. <div class="memitem">

  1447. <div class="memproto">

  1448. <table class="mlabels">

  1449.   <tr>

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

  1451.       <table class="memname">

  1452.         <tr>

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

  1454.           <td>(</td>

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

  1456.           <td> const</td>

  1457.         </tr>

  1458.       </table>

  1459.   </td>

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

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

  1462.   </tr>

  1463. </table>

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

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

  1466. 

  1467. </div>

  1468. </div>

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

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

  1471. 

  1472. <div class="memitem">

  1473. <div class="memproto">

  1474. <table class="mlabels">

  1475.   <tr>

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

  1477.       <table class="memname">

  1478.         <tr>

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

  1480.           <td>(</td>

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

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

  1483.           <td></td>

  1484.         </tr>

  1485.       </table>

  1486.   </td>

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

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

  1489.   </tr>

  1490. </table>

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

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

  1493.   <table class="params">

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

  1495.   </table>

  1496.   </dd>

  1497. </dl>

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

  1499. 

  1500. </div>

  1501. </div>

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

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

  1504. 

  1505. <div class="memitem">

  1506. <div class="memproto">

  1507.       <table class="memname">

  1508.         <tr>

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

  1510.           <td>(</td>

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

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

  1513.         </tr>

  1514.         <tr>

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

  1516.           <td></td>

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

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

  1519.         </tr>

  1520.         <tr>

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

  1522.           <td></td>

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

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

  1525.         </tr>

  1526.         <tr>

  1527.           <td></td>

  1528.           <td>)</td>

  1529.           <td></td><td></td>

  1530.         </tr>

  1531.       </table>

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

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

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

  1535.   <table class="params">

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

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

  1538.   </table>

  1539.   </dd>

  1540. </dl>

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

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

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

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

  1545.   <table class="params">

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

  1547.   </table>

  1548.   </dd>

  1549. </dl>

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

  1551. 

  1552. </div>

  1553. </div>

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

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

  1556. 

  1557. <div class="memitem">

  1558. <div class="memproto">

  1559. <table class="mlabels">

  1560.   <tr>

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

  1562.       <table class="memname">

  1563.         <tr>

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

  1565.           <td>(</td>

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

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

  1568.           <td></td>

  1569.         </tr>

  1570.       </table>

  1571.   </td>

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

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

  1574.   </tr>

  1575. </table>

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

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

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

  1579.   <table class="params">

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

  1581.   </table>

  1582.   </dd>

  1583. </dl>

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

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

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

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

  1588. 

  1589. </div>

  1590. </div>

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

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

  1593. 

  1594. <div class="memitem">

  1595. <div class="memproto">

  1596.       <table class="memname">

  1597.         <tr>

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

  1599.           <td>(</td>

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

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

  1602.         </tr>

  1603.         <tr>

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

  1605.           <td></td>

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

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

  1608.         </tr>

  1609.         <tr>

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

  1611.           <td></td>

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

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

  1614.         </tr>

  1615.         <tr>

  1616.           <td></td>

  1617.           <td>)</td>

  1618.           <td></td><td></td>

  1619.         </tr>

  1620.       </table>

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

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

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

  1624.   <table class="params">

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

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

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

  1628.   </table>

  1629.   </dd>

  1630. </dl>

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

  1632. 

  1633. </div>

  1634. </div>

  1635. <a id="af49a42dc64cd954debb271eae5639059"></a>

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

  1637. 

  1638. <div class="memitem">

  1639. <div class="memproto">

  1640.       <table class="memname">

  1641.         <tr>

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

  1643.           <td>(</td>

  1644.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1645.           <td class="paramname"><em>vol</em>, </td>

  1646.         </tr>

  1647.         <tr>

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

  1649.           <td></td>

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

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

  1652.         </tr>

  1653.         <tr>

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

  1655.           <td></td>

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

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

  1658.         </tr>

  1659.         <tr>

  1660.           <td></td>

  1661.           <td>)</td>

  1662.           <td></td><td></td>

  1663.         </tr>

  1664.       </table>

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

  1666. <p>Open a file in the volume root directory.</p>

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

  1668.   <table class="params">

  1669.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>

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

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

  1672.   </table>

  1673.   </dd>

  1674. </dl>

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

  1676. 

  1677. </div>

  1678. </div>

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

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

  1681. 

  1682. <div class="memitem">

  1683. <div class="memproto">

  1684.       <table class="memname">

  1685.         <tr>

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

  1687.           <td>(</td>

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

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

  1690.         </tr>

  1691.         <tr>

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

  1693.           <td></td>

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

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

  1696.         </tr>

  1697.         <tr>

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

  1699.           <td></td>

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

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

  1702.         </tr>

  1703.         <tr>

  1704.           <td></td>

  1705.           <td>)</td>

  1706.           <td></td><td></td>

  1707.         </tr>

  1708.       </table>

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

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

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

  1712.   <table class="params">

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

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

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

  1716.   </table>

  1717.   </dd>

  1718. </dl>

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

  1720. 

  1721. </div>

  1722. </div>

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

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

  1725. 

  1726. <div class="memitem">

  1727. <div class="memproto">

  1728.       <table class="memname">

  1729.         <tr>

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

  1731.           <td>(</td>

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

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

  1734.         </tr>

  1735.         <tr>

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

  1737.           <td></td>

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

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

  1740.         </tr>

  1741.         <tr>

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

  1743.           <td></td>

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

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

  1746.         </tr>

  1747.         <tr>

  1748.           <td></td>

  1749.           <td>)</td>

  1750.           <td></td><td></td>

  1751.         </tr>

  1752.       </table>

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

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

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

  1756.   <table class="params">

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

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

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

  1760.   </table>

  1761.   </dd>

  1762. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

  1776. 

  1777. </div>

  1778. </div>

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

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

  1781. 

  1782. <div class="memitem">

  1783. <div class="memproto">

  1784.       <table class="memname">

  1785.         <tr>

  1786.           <td class="memname">bool FatFile::open </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> = <code>0X00</code>&#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 current working volume.</p>

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

  1806.   <table class="params">

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

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

  1809.   </table>

  1810.   </dd>

  1811. </dl>

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

  1813. 

  1814. </div>

  1815. </div>

  1816. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>

  1817. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>

  1818. 

  1819. <div class="memitem">

  1820. <div class="memproto">

  1821.       <table class="memname">

  1822.         <tr>

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

  1824.           <td>(</td>

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

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

  1827.         </tr>

  1828.         <tr>

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

  1830.           <td></td>

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

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

  1833.         </tr>

  1834.         <tr>

  1835.           <td></td>

  1836.           <td>)</td>

  1837.           <td></td><td></td>

  1838.         </tr>

  1839.       </table>

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

  1841. <p>Open the next file or subdirectory in a directory.</p>

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

  1843.   <table class="params">

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

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

  1846.   </table>

  1847.   </dd>

  1848. </dl>

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

  1850. 

  1851. </div>

  1852. </div>

  1853. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1854. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>

  1855. 

  1856. <div class="memitem">

  1857. <div class="memproto">

  1858.       <table class="memname">

  1859.         <tr>

  1860.           <td class="memname">bool FatFile::openRoot </td>

  1861.           <td>(</td>

  1862.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1863.           <td class="paramname"><em>vol</em></td><td>)</td>

  1864.           <td></td>

  1865.         </tr>

  1866.       </table>

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

  1868. <p>Open a volume's root directory.</p>

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

  1870.   <table class="params">

  1871.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1872.   </table>

  1873.   </dd>

  1874. </dl>

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

  1876. 

  1877. </div>

  1878. </div>

  1879. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>

  1880. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>

  1881. 

  1882. <div class="memitem">

  1883. <div class="memproto">

  1884. <table class="mlabels">

  1885.   <tr>

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

  1887.       <table class="memname">

  1888.         <tr>

  1889.           <td class="memname">FatFile::operator bool </td>

  1890.           <td>(</td>

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

  1892.           <td></td>

  1893.         </tr>

  1894.       </table>

  1895.   </td>

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

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

  1898.   </tr>

  1899. </table>

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

  1901. <p>The parenthesis operator.</p>

  1902. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  1903. 

  1904. </div>

  1905. </div>

  1906. <a id="ac05b7136b887539426856c623869aa3a"></a>

  1907. <h2 class="memtitle"><span class="permalink"><a href="#ac05b7136b887539426856c623869aa3a">&#9670;&nbsp;</a></span>peek()</h2>

  1908. 

  1909. <div class="memitem">

  1910. <div class="memproto">

  1911.       <table class="memname">

  1912.         <tr>

  1913.           <td class="memname">int FatFile::peek </td>

  1914.           <td>(</td>

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

  1916.           <td></td>

  1917.         </tr>

  1918.       </table>

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

  1920. <p>Return the next available byte without consuming it.</p>

  1921. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1922. 

  1923. </div>

  1924. </div>

  1925. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>

  1926. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>

  1927. 

  1928. <div class="memitem">

  1929. <div class="memproto">

  1930.       <table class="memname">

  1931.         <tr>

  1932.           <td class="memname">bool FatFile::preAllocate </td>

  1933.           <td>(</td>

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

  1935.           <td class="paramname"><em>length</em></td><td>)</td>

  1936.           <td></td>

  1937.         </tr>

  1938.       </table>

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

  1940. <p>Allocate contiguous clusters to an empty file.</p>

  1941. <p>The file must be empty with no clusters allocated.</p>

  1942. <p>The file will contain uninitialized data.</p>

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

  1944.   <table class="params">

  1945.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  1946.   </table>

  1947.   </dd>

  1948. </dl>

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

  1950. 

  1951. </div>

  1952. </div>

  1953. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>

  1954. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>

  1955. 

  1956. <div class="memitem">

  1957. <div class="memproto">

  1958.       <table class="memname">

  1959.         <tr>

  1960.           <td class="memname">size_t FatFile::printAccessDate </td>

  1961.           <td>(</td>

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

  1963.           <td class="paramname"><em>pr</em></td><td>)</td>

  1964.           <td></td>

  1965.         </tr>

  1966.       </table>

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

  1968. <p>Print a file's access date</p>

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

  1970.   <table class="params">

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

  1972.   </table>

  1973.   </dd>

  1974. </dl>

  1975. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  1976. 

  1977. </div>

  1978. </div>

  1979. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>

  1980. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>

  1981. 

  1982. <div class="memitem">

  1983. <div class="memproto">

  1984. <table class="mlabels">

  1985.   <tr>

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

  1987.       <table class="memname">

  1988.         <tr>

  1989.           <td class="memname">size_t FatFile::printAccessDateTime </td>

  1990.           <td>(</td>

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

  1992.           <td class="paramname"><em>pr</em></td><td>)</td>

  1993.           <td></td>

  1994.         </tr>

  1995.       </table>

  1996.   </td>

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

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

  1999.   </tr>

  2000. </table>

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

  2002. <p>Print a file's access date</p>

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

  2004.   <table class="params">

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

  2006.   </table>

  2007.   </dd>

  2008. </dl>

  2009. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2010. 

  2011. </div>

  2012. </div>

  2013. <a id="ab22396a285e27b53501a0047ddd97f59"></a>

  2014. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  2015. 

  2016. <div class="memitem">

  2017. <div class="memproto">

  2018.       <table class="memname">

  2019.         <tr>

  2020.           <td class="memname">size_t FatFile::printCreateDateTime </td>

  2021.           <td>(</td>

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

  2023.           <td class="paramname"><em>pr</em></td><td>)</td>

  2024.           <td></td>

  2025.         </tr>

  2026.       </table>

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

  2028. <p>Print a file's creation date and time</p>

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

  2030.   <table class="params">

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

  2032.   </table>

  2033.   </dd>

  2034. </dl>

  2035. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  2036. 

  2037. </div>

  2038. </div>

  2039. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>

  2040. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>

  2041. 

  2042. <div class="memitem">

  2043. <div class="memproto">

  2044. <table class="mlabels">

  2045.   <tr>

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

  2047.       <table class="memname">

  2048.         <tr>

  2049.           <td class="memname">static void FatFile::printFatDate </td>

  2050.           <td>(</td>

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

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

  2053.         </tr>

  2054.         <tr>

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

  2056.           <td></td>

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

  2058.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2059.         </tr>

  2060.         <tr>

  2061.           <td></td>

  2062.           <td>)</td>

  2063.           <td></td><td></td>

  2064.         </tr>

  2065.       </table>

  2066.   </td>

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

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

  2069.   </tr>

  2070. </table>

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

  2072. <p>Print a directory date field.</p>

  2073. <p>Format is yyyy-mm-dd.</p>

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

  2075.   <table class="params">

  2076.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2077.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2078.   </table>

  2079.   </dd>

  2080. </dl>

  2081. 

  2082. </div>

  2083. </div>

  2084. <a id="a7f84d953190ea94710dad9ebb897b957"></a>

  2085. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>

  2086. 

  2087. <div class="memitem">

  2088. <div class="memproto">

  2089. <table class="mlabels">

  2090.   <tr>

  2091.   <td class="mlabels-left">

  2092.       <table class="memname">

  2093.         <tr>

  2094.           <td class="memname">static void FatFile::printFatTime </td>

  2095.           <td>(</td>

  2096.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2097.           <td class="paramname"><em>pr</em>, </td>

  2098.         </tr>

  2099.         <tr>

  2100.           <td class="paramkey"></td>

  2101.           <td></td>

  2102.           <td class="paramtype">uint16_t&#160;</td>

  2103.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2104.         </tr>

  2105.         <tr>

  2106.           <td></td>

  2107.           <td>)</td>

  2108.           <td></td><td></td>

  2109.         </tr>

  2110.       </table>

  2111.   </td>

  2112.   <td class="mlabels-right">

  2113. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  2114.   </tr>

  2115. </table>

  2116. </div><div class="memdoc">

  2117. <p>Print a directory time field.</p>

  2118. <p>Format is hh:mm:ss.</p>

  2119. <dl class="params"><dt>Parameters</dt><dd>

  2120.   <table class="params">

  2121.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2122.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2123.   </table>

  2124.   </dd>

  2125. </dl>

  2126. 

  2127. </div>

  2128. </div>

  2129. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>

  2130. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  2131. 

  2132. <div class="memitem">

  2133. <div class="memproto">

  2134. <table class="mlabels">

  2135.   <tr>

  2136.   <td class="mlabels-left">

  2137.       <table class="memname">

  2138.         <tr>

  2139.           <td class="memname">size_t FatFile::printField </td>

  2140.           <td>(</td>

  2141.           <td class="paramtype">double&#160;</td>

  2142.           <td class="paramname"><em>value</em>, </td>

  2143.         </tr>

  2144.         <tr>

  2145.           <td class="paramkey"></td>

  2146.           <td></td>

  2147.           <td class="paramtype">char&#160;</td>

  2148.           <td class="paramname"><em>term</em>, </td>

  2149.         </tr>

  2150.         <tr>

  2151.           <td class="paramkey"></td>

  2152.           <td></td>

  2153.           <td class="paramtype">uint8_t&#160;</td>

  2154.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2155.         </tr>

  2156.         <tr>

  2157.           <td></td>

  2158.           <td>)</td>

  2159.           <td></td><td></td>

  2160.         </tr>

  2161.       </table>

  2162.   </td>

  2163.   <td class="mlabels-right">

  2164. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2165.   </tr>

  2166. </table>

  2167. </div><div class="memdoc">

  2168. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2169.   <table class="params">

  2170.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2171.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2172.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2173.   </table>

  2174.   </dd>

  2175. </dl>

  2176. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2177. 

  2178. </div>

  2179. </div>

  2180. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>

  2181. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  2182. 

  2183. <div class="memitem">

  2184. <div class="memproto">

  2185. <table class="mlabels">

  2186.   <tr>

  2187.   <td class="mlabels-left">

  2188.       <table class="memname">

  2189.         <tr>

  2190.           <td class="memname">size_t FatFile::printField </td>

  2191.           <td>(</td>

  2192.           <td class="paramtype">float&#160;</td>

  2193.           <td class="paramname"><em>value</em>, </td>

  2194.         </tr>

  2195.         <tr>

  2196.           <td class="paramkey"></td>

  2197.           <td></td>

  2198.           <td class="paramtype">char&#160;</td>

  2199.           <td class="paramname"><em>term</em>, </td>

  2200.         </tr>

  2201.         <tr>

  2202.           <td class="paramkey"></td>

  2203.           <td></td>

  2204.           <td class="paramtype">uint8_t&#160;</td>

  2205.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2206.         </tr>

  2207.         <tr>

  2208.           <td></td>

  2209.           <td>)</td>

  2210.           <td></td><td></td>

  2211.         </tr>

  2212.       </table>

  2213.   </td>

  2214.   <td class="mlabels-right">

  2215. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2216.   </tr>

  2217. </table>

  2218. </div><div class="memdoc">

  2219. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2220.   <table class="params">

  2221.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2222.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2223.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2224.   </table>

  2225.   </dd>

  2226. </dl>

  2227. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2228. 

  2229. </div>

  2230. </div>

  2231. <a id="a8f906be79086f38943cb0911310d67bf"></a>

  2232. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  2233. 

  2234. <div class="memitem">

  2235. <div class="memproto">

  2236. <div class="memtemplate">

  2237. template&lt;typename Type &gt; </div>

  2238. <table class="mlabels">

  2239.   <tr>

  2240.   <td class="mlabels-left">

  2241.       <table class="memname">

  2242.         <tr>

  2243.           <td class="memname">size_t FatFile::printField </td>

  2244.           <td>(</td>

  2245.           <td class="paramtype">Type&#160;</td>

  2246.           <td class="paramname"><em>value</em>, </td>

  2247.         </tr>

  2248.         <tr>

  2249.           <td class="paramkey"></td>

  2250.           <td></td>

  2251.           <td class="paramtype">char&#160;</td>

  2252.           <td class="paramname"><em>term</em>&#160;</td>

  2253.         </tr>

  2254.         <tr>

  2255.           <td></td>

  2256.           <td>)</td>

  2257.           <td></td><td></td>

  2258.         </tr>

  2259.       </table>

  2260.   </td>

  2261.   <td class="mlabels-right">

  2262. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2263.   </tr>

  2264. </table>

  2265. </div><div class="memdoc">

  2266. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2267.   <table class="params">

  2268.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2269.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2270.   </table>

  2271.   </dd>

  2272. </dl>

  2273. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2274. 

  2275. </div>

  2276. </div>

  2277. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2278. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>

  2279. 

  2280. <div class="memitem">

  2281. <div class="memproto">

  2282.       <table class="memname">

  2283.         <tr>

  2284.           <td class="memname">size_t FatFile::printFileSize </td>

  2285.           <td>(</td>

  2286.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2287.           <td class="paramname"><em>pr</em></td><td>)</td>

  2288.           <td></td>

  2289.         </tr>

  2290.       </table>

  2291. </div><div class="memdoc">

  2292. <p>Print a file's size.</p>

  2293. <dl class="params"><dt>Parameters</dt><dd>

  2294.   <table class="params">

  2295.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2296.   </table>

  2297.   </dd>

  2298. </dl>

  2299. <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>

  2300. 

  2301. </div>

  2302. </div>

  2303. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>

  2304. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>

  2305. 

  2306. <div class="memitem">

  2307. <div class="memproto">

  2308.       <table class="memname">

  2309.         <tr>

  2310.           <td class="memname">size_t FatFile::printModifyDateTime </td>

  2311.           <td>(</td>

  2312.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2313.           <td class="paramname"><em>pr</em></td><td>)</td>

  2314.           <td></td>

  2315.         </tr>

  2316.       </table>

  2317. </div><div class="memdoc">

  2318. <p>Print a file's modify date and time</p>

  2319. <dl class="params"><dt>Parameters</dt><dd>

  2320.   <table class="params">

  2321.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2322.   </table>

  2323.   </dd>

  2324. </dl>

  2325. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2326. 

  2327. </div>

  2328. </div>

  2329. <a id="afe18a787fb8640e2d2483370c770f82f"></a>

  2330. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName() <span class="overload">[1/2]</span></h2>

  2331. 

  2332. <div class="memitem">

  2333. <div class="memproto">

  2334.       <table class="memname">

  2335.         <tr>

  2336.           <td class="memname">size_t FatFile::printName </td>

  2337.           <td>(</td>

  2338.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2339.           <td class="paramname"><em>pr</em></td><td>)</td>

  2340.           <td></td>

  2341.         </tr>

  2342.       </table>

  2343. </div><div class="memdoc">

  2344. <p>Print a file's name</p>

  2345. <dl class="params"><dt>Parameters</dt><dd>

  2346.   <table class="params">

  2347.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2348.   </table>

  2349.   </dd>

  2350. </dl>

  2351. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2352. 

  2353. </div>

  2354. </div>

  2355. <a id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2356. <h2 class="memtitle"><span class="permalink"><a href="#ad1cbc3aeb0f5193b7a26595966da9621">&#9670;&nbsp;</a></span>printName() <span class="overload">[2/2]</span></h2>

  2357. 

  2358. <div class="memitem">

  2359. <div class="memproto">

  2360. <table class="mlabels">

  2361.   <tr>

  2362.   <td class="mlabels-left">

  2363.       <table class="memname">

  2364.         <tr>

  2365.           <td class="memname">size_t FatFile::printName </td>

  2366.           <td>(</td>

  2367.           <td class="paramname"></td><td>)</td>

  2368.           <td></td>

  2369.         </tr>

  2370.       </table>

  2371.   </td>

  2372.   <td class="mlabels-right">

  2373. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2374.   </tr>

  2375. </table>

  2376. </div><div class="memdoc">

  2377. <p>Print a file's name.</p>

  2378. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2379. 

  2380. </div>

  2381. </div>

  2382. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2383. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>

  2384. 

  2385. <div class="memitem">

  2386. <div class="memproto">

  2387.       <table class="memname">

  2388.         <tr>

  2389.           <td class="memname">size_t FatFile::printSFN </td>

  2390.           <td>(</td>

  2391.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2392.           <td class="paramname"><em>pr</em></td><td>)</td>

  2393.           <td></td>

  2394.         </tr>

  2395.       </table>

  2396. </div><div class="memdoc">

  2397. <p>Print a file's Short File Name.</p>

  2398. <dl class="params"><dt>Parameters</dt><dd>

  2399.   <table class="params">

  2400.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2401.   </table>

  2402.   </dd>

  2403. </dl>

  2404. <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>

  2405. 

  2406. </div>

  2407. </div>

  2408. <a id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2409. <h2 class="memtitle"><span class="permalink"><a href="#a60ae55ff6fe158c2340071d702a363c5">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  2410. 

  2411. <div class="memitem">

  2412. <div class="memproto">

  2413. <table class="mlabels">

  2414.   <tr>

  2415.   <td class="mlabels-left">

  2416.       <table class="memname">

  2417.         <tr>

  2418.           <td class="memname">int FatFile::read </td>

  2419.           <td>(</td>

  2420.           <td class="paramname"></td><td>)</td>

  2421.           <td></td>

  2422.         </tr>

  2423.       </table>

  2424.   </td>

  2425.   <td class="mlabels-right">

  2426. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2427.   </tr>

  2428. </table>

  2429. </div><div class="memdoc">

  2430. <p>Read the next byte from a file.</p>

  2431. <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>

  2432. 

  2433. </div>

  2434. </div>

  2435. <a id="aba893af8107a18017482d2311b066187"></a>

  2436. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2437. 

  2438. <div class="memitem">

  2439. <div class="memproto">

  2440.       <table class="memname">

  2441.         <tr>

  2442.           <td class="memname">int FatFile::read </td>

  2443.           <td>(</td>

  2444.           <td class="paramtype">void *&#160;</td>

  2445.           <td class="paramname"><em>buf</em>, </td>

  2446.         </tr>

  2447.         <tr>

  2448.           <td class="paramkey"></td>

  2449.           <td></td>

  2450.           <td class="paramtype">size_t&#160;</td>

  2451.           <td class="paramname"><em>count</em>&#160;</td>

  2452.         </tr>

  2453.         <tr>

  2454.           <td></td>

  2455.           <td>)</td>

  2456.           <td></td><td></td>

  2457.         </tr>

  2458.       </table>

  2459. </div><div class="memdoc">

  2460. <p>Read data from a file starting at the current position.</p>

  2461. <dl class="params"><dt>Parameters</dt><dd>

  2462.   <table class="params">

  2463.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2464.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2465.   </table>

  2466.   </dd>

  2467. </dl>

  2468. <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>

  2469. 

  2470. </div>

  2471. </div>

  2472. <a id="a29502cd34ef186763d2196daef27df1f"></a>

  2473. <h2 class="memtitle"><span class="permalink"><a href="#a29502cd34ef186763d2196daef27df1f">&#9670;&nbsp;</a></span>readDir()</h2>

  2474. 

  2475. <div class="memitem">

  2476. <div class="memproto">

  2477.       <table class="memname">

  2478.         <tr>

  2479.           <td class="memname">int8_t FatFile::readDir </td>

  2480.           <td>(</td>

  2481.           <td class="paramtype">DirFat_t *&#160;</td>

  2482.           <td class="paramname"><em>dir</em></td><td>)</td>

  2483.           <td></td>

  2484.         </tr>

  2485.       </table>

  2486. </div><div class="memdoc">

  2487. <p>Read the next directory entry from a directory file.</p>

  2488. <dl class="params"><dt>Parameters</dt><dd>

  2489.   <table class="params">

  2490.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The DirFat_t struct that will receive the data.</td></tr>

  2491.   </table>

  2492.   </dd>

  2493. </dl>

  2494. <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>

  2495. 

  2496. </div>

  2497. </div>

  2498. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2499. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2500. 

  2501. <div class="memitem">

  2502. <div class="memproto">

  2503.       <table class="memname">

  2504.         <tr>

  2505.           <td class="memname">bool FatFile::remove </td>

  2506.           <td>(</td>

  2507.           <td class="paramname"></td><td>)</td>

  2508.           <td></td>

  2509.         </tr>

  2510.       </table>

  2511. </div><div class="memdoc">

  2512. <p>Remove a file.</p>

  2513. <p>The directory entry and all data for the file are deleted.</p>

  2514. <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>

  2515. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2516. 

  2517. </div>

  2518. </div>

  2519. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>

  2520. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2521. 

  2522. <div class="memitem">

  2523. <div class="memproto">

  2524.       <table class="memname">

  2525.         <tr>

  2526.           <td class="memname">bool FatFile::remove </td>

  2527.           <td>(</td>

  2528.           <td class="paramtype">const char *&#160;</td>

  2529.           <td class="paramname"><em>path</em></td><td>)</td>

  2530.           <td></td>

  2531.         </tr>

  2532.       </table>

  2533. </div><div class="memdoc">

  2534. <p>Remove a file.</p>

  2535. <p>The directory entry and all data for the file are deleted.</p>

  2536. <dl class="params"><dt>Parameters</dt><dd>

  2537.   <table class="params">

  2538.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2539.   </table>

  2540.   </dd>

  2541. </dl>

  2542. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2543. <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>

  2544. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2545. 

  2546. </div>

  2547. </div>

  2548. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>

  2549. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2550. 

  2551. <div class="memitem">

  2552. <div class="memproto">

  2553.       <table class="memname">

  2554.         <tr>

  2555.           <td class="memname">bool FatFile::rename </td>

  2556.           <td>(</td>

  2557.           <td class="paramtype">const char *&#160;</td>

  2558.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2559.           <td></td>

  2560.         </tr>

  2561.       </table>

  2562. </div><div class="memdoc">

  2563. <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>

  2564. <dl class="params"><dt>Parameters</dt><dd>

  2565.   <table class="params">

  2566.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2567.   </table>

  2568.   </dd>

  2569. </dl>

  2570. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2571. 

  2572. </div>

  2573. </div>

  2574. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2575. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2576. 

  2577. <div class="memitem">

  2578. <div class="memproto">

  2579.       <table class="memname">

  2580.         <tr>

  2581.           <td class="memname">bool FatFile::rename </td>

  2582.           <td>(</td>

  2583.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2584.           <td class="paramname"><em>dirFile</em>, </td>

  2585.         </tr>

  2586.         <tr>

  2587.           <td class="paramkey"></td>

  2588.           <td></td>

  2589.           <td class="paramtype">const char *&#160;</td>

  2590.           <td class="paramname"><em>newPath</em>&#160;</td>

  2591.         </tr>

  2592.         <tr>

  2593.           <td></td>

  2594.           <td>)</td>

  2595.           <td></td><td></td>

  2596.         </tr>

  2597.       </table>

  2598. </div><div class="memdoc">

  2599. <p>Rename a file or subdirectory.</p>

  2600. <dl class="params"><dt>Parameters</dt><dd>

  2601.   <table class="params">

  2602.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2603.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2604.   </table>

  2605.   </dd>

  2606. </dl>

  2607. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2608. 

  2609. </div>

  2610. </div>

  2611. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2612. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>

  2613. 

  2614. <div class="memitem">

  2615. <div class="memproto">

  2616. <table class="mlabels">

  2617.   <tr>

  2618.   <td class="mlabels-left">

  2619.       <table class="memname">

  2620.         <tr>

  2621.           <td class="memname">void FatFile::rewind </td>

  2622.           <td>(</td>

  2623.           <td class="paramname"></td><td>)</td>

  2624.           <td></td>

  2625.         </tr>

  2626.       </table>

  2627.   </td>

  2628.   <td class="mlabels-right">

  2629. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2630.   </tr>

  2631. </table>

  2632. </div><div class="memdoc">

  2633. <p>Set the file's current position to zero. </p>

  2634. 

  2635. </div>

  2636. </div>

  2637. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2638. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>

  2639. 

  2640. <div class="memitem">

  2641. <div class="memproto">

  2642.       <table class="memname">

  2643.         <tr>

  2644.           <td class="memname">bool FatFile::rmdir </td>

  2645.           <td>(</td>

  2646.           <td class="paramname"></td><td>)</td>

  2647.           <td></td>

  2648.         </tr>

  2649.       </table>

  2650. </div><div class="memdoc">

  2651. <p>Remove a directory file.</p>

  2652. <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>

  2653. <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>

  2654. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2655. 

  2656. </div>

  2657. </div>

  2658. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2659. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>

  2660. 

  2661. <div class="memitem">

  2662. <div class="memproto">

  2663.       <table class="memname">

  2664.         <tr>

  2665.           <td class="memname">bool FatFile::rmRfStar </td>

  2666.           <td>(</td>

  2667.           <td class="paramname"></td><td>)</td>

  2668.           <td></td>

  2669.         </tr>

  2670.       </table>

  2671. </div><div class="memdoc">

  2672. <p>Recursively delete a directory and all contained files.</p>

  2673. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2674. <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>

  2675. <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>

  2676. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2677. 

  2678. </div>

  2679. </div>

  2680. <a id="a5812037ea30777cc350698ad26f2c73f"></a>

  2681. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>

  2682. 

  2683. <div class="memitem">

  2684. <div class="memproto">

  2685. <table class="mlabels">

  2686.   <tr>

  2687.   <td class="mlabels-left">

  2688.       <table class="memname">

  2689.         <tr>

  2690.           <td class="memname">bool FatFile::seekCur </td>

  2691.           <td>(</td>

  2692.           <td class="paramtype">int32_t&#160;</td>

  2693.           <td class="paramname"><em>offset</em></td><td>)</td>

  2694.           <td></td>

  2695.         </tr>

  2696.       </table>

  2697.   </td>

  2698.   <td class="mlabels-right">

  2699. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2700.   </tr>

  2701. </table>

  2702. </div><div class="memdoc">

  2703. <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>

  2704.   <table class="params">

  2705.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2706.   </table>

  2707.   </dd>

  2708. </dl>

  2709. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2710. 

  2711. </div>

  2712. </div>

  2713. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2714. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>

  2715. 

  2716. <div class="memitem">

  2717. <div class="memproto">

  2718. <table class="mlabels">

  2719.   <tr>

  2720.   <td class="mlabels-left">

  2721.       <table class="memname">

  2722.         <tr>

  2723.           <td class="memname">bool FatFile::seekEnd </td>

  2724.           <td>(</td>

  2725.           <td class="paramtype">int32_t&#160;</td>

  2726.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2727.           <td></td>

  2728.         </tr>

  2729.       </table>

  2730.   </td>

  2731.   <td class="mlabels-right">

  2732. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2733.   </tr>

  2734. </table>

  2735. </div><div class="memdoc">

  2736. <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>

  2737.   <table class="params">

  2738.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2739.   </table>

  2740.   </dd>

  2741. </dl>

  2742. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2743. 

  2744. </div>

  2745. </div>

  2746. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2747. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>

  2748. 

  2749. <div class="memitem">

  2750. <div class="memproto">

  2751.       <table class="memname">

  2752.         <tr>

  2753.           <td class="memname">bool FatFile::seekSet </td>

  2754.           <td>(</td>

  2755.           <td class="paramtype">uint32_t&#160;</td>

  2756.           <td class="paramname"><em>pos</em></td><td>)</td>

  2757.           <td></td>

  2758.         </tr>

  2759.       </table>

  2760. </div><div class="memdoc">

  2761. <p>Sets a file's position.</p>

  2762. <dl class="params"><dt>Parameters</dt><dd>

  2763.   <table class="params">

  2764.     <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>

  2765.   </table>

  2766.   </dd>

  2767. </dl>

  2768. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2769. 

  2770. </div>

  2771. </div>

  2772. <a id="a67f3dc4896c542d695e11aac927f585e"></a>

  2773. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>

  2774. 

  2775. <div class="memitem">

  2776. <div class="memproto">

  2777.       <table class="memname">

  2778.         <tr>

  2779.           <td class="memname">bool FatFile::sync </td>

  2780.           <td>(</td>

  2781.           <td class="paramname"></td><td>)</td>

  2782.           <td></td>

  2783.         </tr>

  2784.       </table>

  2785. </div><div class="memdoc">

  2786. <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>

  2787. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2788. 

  2789. </div>

  2790. </div>

  2791. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2792. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>

  2793. 

  2794. <div class="memitem">

  2795. <div class="memproto">

  2796.       <table class="memname">

  2797.         <tr>

  2798.           <td class="memname">bool FatFile::timestamp </td>

  2799.           <td>(</td>

  2800.           <td class="paramtype">uint8_t&#160;</td>

  2801.           <td class="paramname"><em>flags</em>, </td>

  2802.         </tr>

  2803.         <tr>

  2804.           <td class="paramkey"></td>

  2805.           <td></td>

  2806.           <td class="paramtype">uint16_t&#160;</td>

  2807.           <td class="paramname"><em>year</em>, </td>

  2808.         </tr>

  2809.         <tr>

  2810.           <td class="paramkey"></td>

  2811.           <td></td>

  2812.           <td class="paramtype">uint8_t&#160;</td>

  2813.           <td class="paramname"><em>month</em>, </td>

  2814.         </tr>

  2815.         <tr>

  2816.           <td class="paramkey"></td>

  2817.           <td></td>

  2818.           <td class="paramtype">uint8_t&#160;</td>

  2819.           <td class="paramname"><em>day</em>, </td>

  2820.         </tr>

  2821.         <tr>

  2822.           <td class="paramkey"></td>

  2823.           <td></td>

  2824.           <td class="paramtype">uint8_t&#160;</td>

  2825.           <td class="paramname"><em>hour</em>, </td>

  2826.         </tr>

  2827.         <tr>

  2828.           <td class="paramkey"></td>

  2829.           <td></td>

  2830.           <td class="paramtype">uint8_t&#160;</td>

  2831.           <td class="paramname"><em>minute</em>, </td>

  2832.         </tr>

  2833.         <tr>

  2834.           <td class="paramkey"></td>

  2835.           <td></td>

  2836.           <td class="paramtype">uint8_t&#160;</td>

  2837.           <td class="paramname"><em>second</em>&#160;</td>

  2838.         </tr>

  2839.         <tr>

  2840.           <td></td>

  2841.           <td>)</td>

  2842.           <td></td><td></td>

  2843.         </tr>

  2844.       </table>

  2845. </div><div class="memdoc">

  2846. <p>Set a file's timestamps in its directory entry.</p>

  2847. <dl class="params"><dt>Parameters</dt><dd>

  2848.   <table class="params">

  2849.     <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>

  2850.   </table>

  2851.   </dd>

  2852. </dl>

  2853. <p>T_ACCESS - Set the file's last access date.</p>

  2854. <p>T_CREATE - Set the file's creation date and time.</p>

  2855. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2856. <dl class="params"><dt>Parameters</dt><dd>

  2857.   <table class="params">

  2858.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2859.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2860.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2861.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2862.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2863.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2864.   </table>

  2865.   </dd>

  2866. </dl>

  2867. <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>

  2868. <dd>

  2869. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2870. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2871. 

  2872. </div>

  2873. </div>

  2874. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>

  2875. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2876. 

  2877. <div class="memitem">

  2878. <div class="memproto">

  2879.       <table class="memname">

  2880.         <tr>

  2881.           <td class="memname">bool FatFile::truncate </td>

  2882.           <td>(</td>

  2883.           <td class="paramname"></td><td>)</td>

  2884.           <td></td>

  2885.         </tr>

  2886.       </table>

  2887. </div><div class="memdoc">

  2888. <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>

  2889. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2890. 

  2891. </div>

  2892. </div>

  2893. <a id="aa6e663098a578635d37d92e82d18d616"></a>

  2894. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2895. 

  2896. <div class="memitem">

  2897. <div class="memproto">

  2898. <table class="mlabels">

  2899.   <tr>

  2900.   <td class="mlabels-left">

  2901.       <table class="memname">

  2902.         <tr>

  2903.           <td class="memname">bool FatFile::truncate </td>

  2904.           <td>(</td>

  2905.           <td class="paramtype">uint32_t&#160;</td>

  2906.           <td class="paramname"><em>length</em></td><td>)</td>

  2907.           <td></td>

  2908.         </tr>

  2909.       </table>

  2910.   </td>

  2911.   <td class="mlabels-right">

  2912. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2913.   </tr>

  2914. </table>

  2915. </div><div class="memdoc">

  2916. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  2917. <dl class="params"><dt>Parameters</dt><dd>

  2918.   <table class="params">

  2919.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2920.   </table>

  2921.   </dd>

  2922. </dl>

  2923. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2924. 

  2925. </div>

  2926. </div>

  2927. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>

  2928. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  2929. 

  2930. <div class="memitem">

  2931. <div class="memproto">

  2932. <table class="mlabels">

  2933.   <tr>

  2934.   <td class="mlabels-left">

  2935.       <table class="memname">

  2936.         <tr>

  2937.           <td class="memname">size_t FatFile::write </td>

  2938.           <td>(</td>

  2939.           <td class="paramtype">const char *&#160;</td>

  2940.           <td class="paramname"><em>str</em></td><td>)</td>

  2941.           <td></td>

  2942.         </tr>

  2943.       </table>

  2944.   </td>

  2945.   <td class="mlabels-right">

  2946. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2947.   </tr>

  2948. </table>

  2949. </div><div class="memdoc">

  2950. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2951.   <table class="params">

  2952.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2953.   </table>

  2954.   </dd>

  2955. </dl>

  2956. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2957. 

  2958. </div>

  2959. </div>

  2960. <a id="ae51e724ac6cc3d67d64a5a666d5850f1"></a>

  2961. <h2 class="memtitle"><span class="permalink"><a href="#ae51e724ac6cc3d67d64a5a666d5850f1">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  2962. 

  2963. <div class="memitem">

  2964. <div class="memproto">

  2965. <table class="mlabels">

  2966.   <tr>

  2967.   <td class="mlabels-left">

  2968.       <table class="memname">

  2969.         <tr>

  2970.           <td class="memname">size_t FatFile::write </td>

  2971.           <td>(</td>

  2972.           <td class="paramtype">uint8_t&#160;</td>

  2973.           <td class="paramname"><em>b</em></td><td>)</td>

  2974.           <td></td>

  2975.         </tr>

  2976.       </table>

  2977.   </td>

  2978.   <td class="mlabels-right">

  2979. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2980.   </tr>

  2981. </table>

  2982. </div><div class="memdoc">

  2983. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2984.   <table class="params">

  2985.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2986.   </table>

  2987.   </dd>

  2988. </dl>

  2989. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  2990. 

  2991. </div>

  2992. </div>

  2993. <a id="a5d84d871ac904a22aa48308713d14682"></a>

  2994. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  2995. 

  2996. <div class="memitem">

  2997. <div class="memproto">

  2998.       <table class="memname">

  2999.         <tr>

  3000.           <td class="memname">size_t FatFile::write </td>

  3001.           <td>(</td>

  3002.           <td class="paramtype">const void *&#160;</td>

  3003.           <td class="paramname"><em>buf</em>, </td>

  3004.         </tr>

  3005.         <tr>

  3006.           <td class="paramkey"></td>

  3007.           <td></td>

  3008.           <td class="paramtype">size_t&#160;</td>

  3009.           <td class="paramname"><em>count</em>&#160;</td>

  3010.         </tr>

  3011.         <tr>

  3012.           <td></td>

  3013.           <td>)</td>

  3014.           <td></td><td></td>

  3015.         </tr>

  3016.       </table>

  3017. </div><div class="memdoc">

  3018. <p>Write data to an open file.</p>

  3019. <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>

  3020. <dl class="params"><dt>Parameters</dt><dd>

  3021.   <table class="params">

  3022.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3023.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  3024.   </table>

  3025.   </dd>

  3026. </dl>

  3027. <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>

  3028. 

  3029. </div>

  3030. </div>

  3031. <h2 class="groupheader">Friends And Related Function Documentation</h2>

  3032. <a id="a6ca3f436167f187097347a20ea221555"></a>

  3033. <h2 class="memtitle"><span class="permalink"><a href="#a6ca3f436167f187097347a20ea221555">&#9670;&nbsp;</a></span>FatVolume</h2>

  3034. 

  3035. <div class="memitem">

  3036. <div class="memproto">

  3037. <table class="mlabels">

  3038.   <tr>

  3039.   <td class="mlabels-left">

  3040.       <table class="memname">

  3041.         <tr>

  3042.           <td class="memname">friend class <a class="el" href="class_fat_volume.html">FatVolume</a></td>

  3043.         </tr>

  3044.       </table>

  3045.   </td>

  3046.   <td class="mlabels-right">

  3047. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  3048.   </tr>

  3049. </table>

  3050. </div><div class="memdoc">

  3051. <p><a class="el" href="class_fat_volume.html" title="Integration class for the FatLib library. ">FatVolume</a> allowed access to private members. </p>

  3052. 

  3053. </div>

  3054. </div>

  3055. <hr/>The documentation for this class was generated from the following files:<ul>

  3056. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  3057. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFile.cpp</li>

  3058. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFileLFN.cpp</li>

  3059. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFilePrint.cpp</li>

  3060. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFileSFN.cpp</li>

  3061. </ul>

  3062. </div><!-- contents -->

  3063. <!-- start footer part -->

  3064. <hr class="footer"/><address class="footer"><small>

  3065. Generated on Mon Nov 18 2019 08:14:17 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3066. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3067. </a> 1.8.14

  3068. </small></address>

  3069. </body>

  3070. </html>