visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/class_file32.html

3563 lines
158KB
Raw Permalink Blame History 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

  67. <a href="class_file32-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">File32 Class Reference</div>  </div>

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

  71. <div class="contents">

  72. 

  73. <p>FAT16/FAT32 file with Arduino Stream.  

  74.  <a href="class_file32.html#details">More...</a></p>

  75. 

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

  77. <div class="dynheader">

  78. Inheritance diagram for File32:</div>

  79. <div class="dyncontent">

  80. <div class="center"><img src="class_file32__inherit__graph.png" border="0" usemap="#_file32_inherit__map" alt="Inheritance graph"/></div>

  81. <map name="_file32_inherit__map" id="_file32_inherit__map">

  82. <area shape="rect" title="FAT16/FAT32 file with Arduino Stream." alt="" coords="59,169,116,196"/>

  83. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="17,80,158,121"/>

  84. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>

  85. <area shape="rect" href="class_fat_file.html" title="Basic file class." alt="" coords="103,5,165,32"/>

  86. </map>

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

  88. <div class="dynheader">

  89. Collaboration diagram for File32:</div>

  90. <div class="dyncontent">

  91. <div class="center"><img src="class_file32__coll__graph.png" border="0" usemap="#_file32_coll__map" alt="Collaboration graph"/></div>

  92. <map name="_file32_coll__map" id="_file32_coll__map">

  93. <area shape="rect" title="FAT16/FAT32 file with Arduino Stream." alt="" coords="59,169,116,196"/>

  94. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="17,80,158,121"/>

  95. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>

  96. <area shape="rect" href="class_fat_file.html" title="Basic file class." alt="" coords="103,5,165,32"/>

  97. </map>

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

  99. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  114. <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 <a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a>)</td></tr>

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

  116. <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 <a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  190. <tr class="memitem:a8792c863080576eb65ce6cacbe1dd931"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a8792c863080576eb65ce6cacbe1dd931">name</a> () const</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  202. <tr class="memitem:a571434707124ee554d659ec82e2ef750"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file32.html">File32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file32.html#a571434707124ee554d659ec82e2ef750">openNextFile</a> (oflag_t oflag=0X00)</td></tr>

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

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

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

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

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

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

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

  210. <tr class="memitem:a18a04d1e68a0c1e3e38e5712cd9bbc03"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a18a04d1e68a0c1e3e38e5712cd9bbc03">position</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  253. <tr class="memitem:a91e8cfbde27d6879b4f51d2ceb2a9f06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a91e8cfbde27d6879b4f51d2ceb2a9f06">rewindDirectory</a> ()</td></tr>

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

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

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

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

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

  259. <tr class="memitem:a773ee6f661fc689a5187f51cb5498086"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a773ee6f661fc689a5187f51cb5498086">seek</a> (uint32_t pos)</td></tr>

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

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

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

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

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

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

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

  267. <tr class="memitem:a5813d451e7f7ba57a04d177caffc5a9f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  279. <tr class="memitem:a0ace3aaaf6d0fb673a43059c0664fab6"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a0ace3aaaf6d0fb673a43059c0664fab6">write</a> (const uint8_t *buffer, size_t <a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  294. </table>

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

  296. <div class="textblock"><p>FAT16/FAT32 file with Arduino Stream. </p>

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

  298. <a id="a0112cc39b64aac6f1ec47741397a7582"></a>

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

  300. 

  301. <div class="memitem">

  302. <div class="memproto">

  303. <table class="mlabels">

  304.   <tr>

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

  306.       <table class="memname">

  307.         <tr>

  308.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::available </td>

  309.           <td>(</td>

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

  311.           <td></td>

  312.         </tr>

  313.       </table>

  314.   </td>

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

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

  317.   </tr>

  318. </table>

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

  320. <dl class="section return"><dt>Returns</dt><dd>number of bytes available from the current position to EOF or INT_MAX if more than INT_MAX bytes are available. </dd></dl>

  321. 

  322. </div>

  323. </div>

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

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

  326. 

  327. <div class="memitem">

  328. <div class="memproto">

  329. <table class="mlabels">

  330.   <tr>

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

  332.       <table class="memname">

  333.         <tr>

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

  335.           <td>(</td>

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

  337.           <td></td>

  338.         </tr>

  339.       </table>

  340.   </td>

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

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

  343.   </tr>

  344. </table>

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

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

  347. 

  348. </div>

  349. </div>

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

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

  352. 

  353. <div class="memitem">

  354. <div class="memproto">

  355. <table class="mlabels">

  356.   <tr>

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

  358.       <table class="memname">

  359.         <tr>

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

  361.           <td>(</td>

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

  363.           <td></td>

  364.         </tr>

  365.       </table>

  366.   </td>

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

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

  369.   </tr>

  370. </table>

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

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

  373. 

  374. </div>

  375. </div>

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

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

  378. 

  379. <div class="memitem">

  380. <div class="memproto">

  381. <table class="mlabels">

  382.   <tr>

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

  384.       <table class="memname">

  385.         <tr>

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

  387.           <td>(</td>

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

  389.           <td></td>

  390.         </tr>

  391.       </table>

  392.   </td>

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

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

  395.   </tr>

  396. </table>

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

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

  399. 

  400. </div>

  401. </div>

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

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

  404. 

  405. <div class="memitem">

  406. <div class="memproto">

  407. <table class="mlabels">

  408.   <tr>

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

  410.       <table class="memname">

  411.         <tr>

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

  413.           <td>(</td>

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

  415.           <td></td>

  416.         </tr>

  417.       </table>

  418.   </td>

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

  420. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  421.   </tr>

  422. </table>

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

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

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

  426. 

  427. </div>

  428. </div>

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

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

  431. 

  432. <div class="memitem">

  433. <div class="memproto">

  434. <table class="mlabels">

  435.   <tr>

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

  437.       <table class="memname">

  438.         <tr>

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

  440.           <td>(</td>

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

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

  443.         </tr>

  444.         <tr>

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

  446.           <td></td>

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

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

  449.         </tr>

  450.         <tr>

  451.           <td></td>

  452.           <td>)</td>

  453.           <td></td><td></td>

  454.         </tr>

  455.       </table>

  456.   </td>

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

  458. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  459.   </tr>

  460. </table>

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

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

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

  464.   <table class="params">

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

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

  467.   </table>

  468.   </dd>

  469. </dl>

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

  471. 

  472. </div>

  473. </div>

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

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

  476. 

  477. <div class="memitem">

  478. <div class="memproto">

  479. <table class="mlabels">

  480.   <tr>

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

  482.       <table class="memname">

  483.         <tr>

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

  485.           <td>(</td>

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

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

  488.         </tr>

  489.         <tr>

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

  491.           <td></td>

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

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

  494.         </tr>

  495.         <tr>

  496.           <td></td>

  497.           <td>)</td>

  498.           <td></td><td></td>

  499.         </tr>

  500.       </table>

  501.   </td>

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

  503. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  504.   </tr>

  505. </table>

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

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

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

  509.   <table class="params">

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

  511.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The desired file size.</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">[2/2]</span></h2>

  521. 

  522. <div class="memitem">

  523. <div class="memproto">

  524. <table class="mlabels">

  525.   <tr>

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

  527.       <table class="memname">

  528.         <tr>

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

  530.           <td>(</td>

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

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

  533.         </tr>

  534.         <tr>

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

  536.           <td></td>

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

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

  539.         </tr>

  540.         <tr>

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

  542.           <td></td>

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

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

  545.         </tr>

  546.         <tr>

  547.           <td></td>

  548.           <td>)</td>

  549.           <td></td><td></td>

  550.         </tr>

  551.       </table>

  552.   </td>

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

  554. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  555.   </tr>

  556. </table>

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

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

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

  560.   <table class="params">

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

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

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

  564.   </table>

  565.   </dd>

  566. </dl>

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

  568. 

  569. </div>

  570. </div>

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

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

  573. 

  574. <div class="memitem">

  575. <div class="memproto">

  576. <table class="mlabels">

  577.   <tr>

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

  579.       <table class="memname">

  580.         <tr>

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

  582.           <td>(</td>

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

  584.           <td> const</td>

  585.         </tr>

  586.       </table>

  587.   </td>

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

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

  590.   </tr>

  591. </table>

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

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

  594. 

  595. </div>

  596. </div>

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

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

  599. 

  600. <div class="memitem">

  601. <div class="memproto">

  602. <table class="mlabels">

  603.   <tr>

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

  605.       <table class="memname">

  606.         <tr>

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

  608.           <td>(</td>

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

  610.           <td> const</td>

  611.         </tr>

  612.       </table>

  613.   </td>

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

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

  616.   </tr>

  617. </table>

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

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

  620. 

  621. </div>

  622. </div>

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

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

  625. 

  626. <div class="memitem">

  627. <div class="memproto">

  628. <table class="mlabels">

  629.   <tr>

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

  631.       <table class="memname">

  632.         <tr>

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

  634.           <td>(</td>

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

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

  637.           <td></td>

  638.         </tr>

  639.       </table>

  640.   </td>

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

  642. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  643.   </tr>

  644. </table>

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

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

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

  648.   <table class="params">

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

  650.   </table>

  651.   </dd>

  652. </dl>

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

  654. 

  655. </div>

  656. </div>

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

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

  659. 

  660. <div class="memitem">

  661. <div class="memproto">

  662. <table class="mlabels">

  663.   <tr>

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

  665.       <table class="memname">

  666.         <tr>

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

  668.           <td>(</td>

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

  670.           <td></td>

  671.         </tr>

  672.       </table>

  673.   </td>

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

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

  676.   </tr>

  677. </table>

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

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

  680. 

  681. </div>

  682. </div>

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

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

  685. 

  686. <div class="memitem">

  687. <div class="memproto">

  688. <table class="mlabels">

  689.   <tr>

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

  691.       <table class="memname">

  692.         <tr>

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

  694.           <td>(</td>

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

  696.           <td></td>

  697.         </tr>

  698.       </table>

  699.   </td>

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

  701. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  702.   </tr>

  703. </table>

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

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

  706. 

  707. </div>

  708. </div>

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

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

  711. 

  712. <div class="memitem">

  713. <div class="memproto">

  714. <table class="mlabels">

  715.   <tr>

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

  717.       <table class="memname">

  718.         <tr>

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

  720.           <td>(</td>

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

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

  723.         </tr>

  724.         <tr>

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

  726.           <td></td>

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

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

  729.         </tr>

  730.         <tr>

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

  732.           <td></td>

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

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

  735.         </tr>

  736.         <tr>

  737.           <td></td>

  738.           <td>)</td>

  739.           <td></td><td></td>

  740.         </tr>

  741.       </table>

  742.   </td>

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

  744. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  745.   </tr>

  746. </table>

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

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

  749.   <table class="params">

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

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

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

  753.   </table>

  754.   </dd>

  755. </dl>

  756. 

  757. </div>

  758. </div>

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

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

  761. 

  762. <div class="memitem">

  763. <div class="memproto">

  764. <table class="mlabels">

  765.   <tr>

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

  767.       <table class="memname">

  768.         <tr>

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

  770.           <td>(</td>

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

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

  773.           <td></td>

  774.         </tr>

  775.       </table>

  776.   </td>

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

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

  779.   </tr>

  780. </table>

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

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

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

  784.   <table class="params">

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

  786.   </table>

  787.   </dd>

  788. </dl>

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

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

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

  792. 

  793. </div>

  794. </div>

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

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

  797. 

  798. <div class="memitem">

  799. <div class="memproto">

  800. <table class="mlabels">

  801.   <tr>

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

  803.       <table class="memname">

  804.         <tr>

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

  806.           <td>(</td>

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

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

  809.           <td></td>

  810.         </tr>

  811.       </table>

  812.   </td>

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

  814. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  815.   </tr>

  816. </table>

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

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

  819.   <table class="params">

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

  821.   </table>

  822.   </dd>

  823. </dl>

  824. 

  825. </div>

  826. </div>

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

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

  829. 

  830. <div class="memitem">

  831. <div class="memproto">

  832. <table class="mlabels">

  833.   <tr>

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

  835.       <table class="memname">

  836.         <tr>

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

  838.           <td>(</td>

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

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

  841.         </tr>

  842.         <tr>

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

  844.           <td></td>

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

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

  847.         </tr>

  848.         <tr>

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

  850.           <td></td>

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

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

  853.         </tr>

  854.         <tr>

  855.           <td></td>

  856.           <td>)</td>

  857.           <td></td><td></td>

  858.         </tr>

  859.       </table>

  860.   </td>

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

  862. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  863.   </tr>

  864. </table>

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

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

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

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

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

  870.   <table class="params">

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

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

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

  874.   </table>

  875.   </dd>

  876. </dl>

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

  878. 

  879. </div>

  880. </div>

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

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

  883. 

  884. <div class="memitem">

  885. <div class="memproto">

  886. <table class="mlabels">

  887.   <tr>

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

  889.       <table class="memname">

  890.         <tr>

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

  892.           <td>(</td>

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

  894.           <td> const</td>

  895.         </tr>

  896.       </table>

  897.   </td>

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

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

  900.   </tr>

  901. </table>

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

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

  904. 

  905. </div>

  906. </div>

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

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

  909. 

  910. <div class="memitem">

  911. <div class="memproto">

  912. <table class="mlabels">

  913.   <tr>

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

  915.       <table class="memname">

  916.         <tr>

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

  918.           <td>(</td>

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

  920.           <td> const</td>

  921.         </tr>

  922.       </table>

  923.   </td>

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

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

  926.   </tr>

  927. </table>

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

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

  930. 

  931. </div>

  932. </div>

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

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

  935. 

  936. <div class="memitem">

  937. <div class="memproto">

  938. <table class="mlabels">

  939.   <tr>

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

  941.       <table class="memname">

  942.         <tr>

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

  944.           <td>(</td>

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

  946.           <td> const</td>

  947.         </tr>

  948.       </table>

  949.   </td>

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

  951. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  952.   </tr>

  953. </table>

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

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

  956. 

  957. </div>

  958. </div>

  959. <a id="a32f813e659414892a58aa5157fe14f82"></a>

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

  961. 

  962. <div class="memitem">

  963. <div class="memproto">

  964. <table class="mlabels">

  965.   <tr>

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

  967.       <table class="memname">

  968.         <tr>

  969.           <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::flush </td>

  970.           <td>(</td>

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

  972.           <td></td>

  973.         </tr>

  974.       </table>

  975.   </td>

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

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

  978.   </tr>

  979. </table>

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

  981. <p>Ensure that any bytes written to the file are saved to the SD card. </p>

  982. 

  983. </div>

  984. </div>

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

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

  987. 

  988. <div class="memitem">

  989. <div class="memproto">

  990. <table class="mlabels">

  991.   <tr>

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

  993.       <table class="memname">

  994.         <tr>

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

  996.           <td>(</td>

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

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

  999.           <td></td>

  1000.         </tr>

  1001.       </table>

  1002.   </td>

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

  1004. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1005.   </tr>

  1006. </table>

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

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

  1009.   <table class="params">

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

  1011.   </table>

  1012.   </dd>

  1013. </dl>

  1014. 

  1015. </div>

  1016. </div>

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

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

  1019. 

  1020. <div class="memitem">

  1021. <div class="memproto">

  1022. <table class="mlabels">

  1023.   <tr>

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

  1025.       <table class="memname">

  1026.         <tr>

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

  1028.           <td>(</td>

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

  1030.           <td></td>

  1031.         </tr>

  1032.       </table>

  1033.   </td>

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

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

  1036.   </tr>

  1037. </table>

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

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

  1040. 

  1041. </div>

  1042. </div>

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

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

  1045. 

  1046. <div class="memitem">

  1047. <div class="memproto">

  1048. <table class="mlabels">

  1049.   <tr>

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

  1051.       <table class="memname">

  1052.         <tr>

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

  1054.           <td>(</td>

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

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

  1057.         </tr>

  1058.         <tr>

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

  1060.           <td></td>

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

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

  1063.         </tr>

  1064.         <tr>

  1065.           <td></td>

  1066.           <td>)</td>

  1067.           <td></td><td></td>

  1068.         </tr>

  1069.       </table>

  1070.   </td>

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

  1072. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1073.   </tr>

  1074. </table>

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

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

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

  1078.   <table class="params">

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

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

  1081.   </table>

  1082.   </dd>

  1083. </dl>

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

  1085. 

  1086. </div>

  1087. </div>

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

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

  1090. 

  1091. <div class="memitem">

  1092. <div class="memproto">

  1093. <table class="mlabels">

  1094.   <tr>

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

  1096.       <table class="memname">

  1097.         <tr>

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

  1099.           <td>(</td>

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

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

  1102.           <td></td>

  1103.         </tr>

  1104.       </table>

  1105.   </td>

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

  1107. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1108.   </tr>

  1109. </table>

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

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

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

  1113.   <table class="params">

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

  1115.   </table>

  1116.   </dd>

  1117. </dl>

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

  1119. 

  1120. </div>

  1121. </div>

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

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

  1124. 

  1125. <div class="memitem">

  1126. <div class="memproto">

  1127. <table class="mlabels">

  1128.   <tr>

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

  1130.       <table class="memname">

  1131.         <tr>

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

  1133.           <td>(</td>

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

  1135.           <td></td>

  1136.         </tr>

  1137.       </table>

  1138.   </td>

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

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

  1141.   </tr>

  1142. </table>

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

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

  1145. 

  1146. </div>

  1147. </div>

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

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

  1150. 

  1151. <div class="memitem">

  1152. <div class="memproto">

  1153. <table class="mlabels">

  1154.   <tr>

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

  1156.       <table class="memname">

  1157.         <tr>

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

  1159.           <td>(</td>

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

  1161.           <td> const</td>

  1162.         </tr>

  1163.       </table>

  1164.   </td>

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

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

  1167.   </tr>

  1168. </table>

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

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

  1171. 

  1172. </div>

  1173. </div>

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

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

  1176. 

  1177. <div class="memitem">

  1178. <div class="memproto">

  1179. <table class="mlabels">

  1180.   <tr>

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

  1182.       <table class="memname">

  1183.         <tr>

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

  1185.           <td>(</td>

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

  1187.           <td> const</td>

  1188.         </tr>

  1189.       </table>

  1190.   </td>

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

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

  1193.   </tr>

  1194. </table>

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

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

  1197. 

  1198. </div>

  1199. </div>

  1200. <a id="a586ad44055eca4c1b2b457299b829d44"></a>

  1201. <h2 class="memtitle"><span class="permalink"><a href="#a586ad44055eca4c1b2b457299b829d44">&#9670;&nbsp;</a></span>isDirectory()</h2>

  1202. 

  1203. <div class="memitem">

  1204. <div class="memproto">

  1205. <table class="mlabels">

  1206.   <tr>

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

  1208.       <table class="memname">

  1209.         <tr>

  1210.           <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::isDirectory </td>

  1211.           <td>(</td>

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

  1213.           <td></td>

  1214.         </tr>

  1215.       </table>

  1216.   </td>

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

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

  1219.   </tr>

  1220. </table>

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

  1222. <p>This function reports if the current file is a directory or not. </p><dl class="section return"><dt>Returns</dt><dd>true if the file is a directory. </dd></dl>

  1223. 

  1224. </div>

  1225. </div>

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

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

  1228. 

  1229. <div class="memitem">

  1230. <div class="memproto">

  1231. <table class="mlabels">

  1232.   <tr>

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

  1234.       <table class="memname">

  1235.         <tr>

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

  1237.           <td>(</td>

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

  1239.           <td> const</td>

  1240.         </tr>

  1241.       </table>

  1242.   </td>

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

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

  1245.   </tr>

  1246. </table>

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

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

  1249. 

  1250. </div>

  1251. </div>

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

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

  1254. 

  1255. <div class="memitem">

  1256. <div class="memproto">

  1257. <table class="mlabels">

  1258.   <tr>

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

  1260.       <table class="memname">

  1261.         <tr>

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

  1263.           <td>(</td>

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

  1265.           <td> const</td>

  1266.         </tr>

  1267.       </table>

  1268.   </td>

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

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

  1271.   </tr>

  1272. </table>

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

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

  1275. 

  1276. </div>

  1277. </div>

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

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

  1280. 

  1281. <div class="memitem">

  1282. <div class="memproto">

  1283. <table class="mlabels">

  1284.   <tr>

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

  1286.       <table class="memname">

  1287.         <tr>

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

  1289.           <td>(</td>

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

  1291.           <td> const</td>

  1292.         </tr>

  1293.       </table>

  1294.   </td>

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

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

  1297.   </tr>

  1298. </table>

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

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

  1301. 

  1302. </div>

  1303. </div>

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

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

  1306. 

  1307. <div class="memitem">

  1308. <div class="memproto">

  1309. <table class="mlabels">

  1310.   <tr>

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

  1312.       <table class="memname">

  1313.         <tr>

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

  1315.           <td>(</td>

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

  1317.           <td> const</td>

  1318.         </tr>

  1319.       </table>

  1320.   </td>

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

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

  1323.   </tr>

  1324. </table>

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

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

  1327. 

  1328. </div>

  1329. </div>

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

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

  1332. 

  1333. <div class="memitem">

  1334. <div class="memproto">

  1335. <table class="mlabels">

  1336.   <tr>

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

  1338.       <table class="memname">

  1339.         <tr>

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

  1341.           <td>(</td>

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

  1343.           <td> const</td>

  1344.         </tr>

  1345.       </table>

  1346.   </td>

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

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

  1349.   </tr>

  1350. </table>

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

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

  1353. 

  1354. </div>

  1355. </div>

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

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

  1358. 

  1359. <div class="memitem">

  1360. <div class="memproto">

  1361. <table class="mlabels">

  1362.   <tr>

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

  1364.       <table class="memname">

  1365.         <tr>

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

  1367.           <td>(</td>

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

  1369.           <td> const</td>

  1370.         </tr>

  1371.       </table>

  1372.   </td>

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

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

  1375.   </tr>

  1376. </table>

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

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

  1379. 

  1380. </div>

  1381. </div>

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

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

  1384. 

  1385. <div class="memitem">

  1386. <div class="memproto">

  1387. <table class="mlabels">

  1388.   <tr>

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

  1390.       <table class="memname">

  1391.         <tr>

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

  1393.           <td>(</td>

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

  1395.           <td> const</td>

  1396.         </tr>

  1397.       </table>

  1398.   </td>

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

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

  1401.   </tr>

  1402. </table>

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

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

  1405. 

  1406. </div>

  1407. </div>

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

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

  1410. 

  1411. <div class="memitem">

  1412. <div class="memproto">

  1413. <table class="mlabels">

  1414.   <tr>

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

  1416.       <table class="memname">

  1417.         <tr>

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

  1419.           <td>(</td>

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

  1421.           <td> const</td>

  1422.         </tr>

  1423.       </table>

  1424.   </td>

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

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

  1427.   </tr>

  1428. </table>

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

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

  1431. 

  1432. </div>

  1433. </div>

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

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

  1436. 

  1437. <div class="memitem">

  1438. <div class="memproto">

  1439. <table class="mlabels">

  1440.   <tr>

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

  1442.       <table class="memname">

  1443.         <tr>

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

  1445.           <td>(</td>

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

  1447.           <td> const</td>

  1448.         </tr>

  1449.       </table>

  1450.   </td>

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

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

  1453.   </tr>

  1454. </table>

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

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

  1457. 

  1458. </div>

  1459. </div>

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

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

  1462. 

  1463. <div class="memitem">

  1464. <div class="memproto">

  1465. <table class="mlabels">

  1466.   <tr>

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

  1468.       <table class="memname">

  1469.         <tr>

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

  1471.           <td>(</td>

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

  1473.           <td> const</td>

  1474.         </tr>

  1475.       </table>

  1476.   </td>

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

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

  1479.   </tr>

  1480. </table>

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

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

  1483. 

  1484. </div>

  1485. </div>

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

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

  1488. 

  1489. <div class="memitem">

  1490. <div class="memproto">

  1491. <table class="mlabels">

  1492.   <tr>

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

  1494.       <table class="memname">

  1495.         <tr>

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

  1497.           <td>(</td>

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

  1499.           <td> const</td>

  1500.         </tr>

  1501.       </table>

  1502.   </td>

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

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

  1505.   </tr>

  1506. </table>

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

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

  1509. 

  1510. </div>

  1511. </div>

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

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

  1514. 

  1515. <div class="memitem">

  1516. <div class="memproto">

  1517. <table class="mlabels">

  1518.   <tr>

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

  1520.       <table class="memname">

  1521.         <tr>

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

  1523.           <td>(</td>

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

  1525.           <td> const</td>

  1526.         </tr>

  1527.       </table>

  1528.   </td>

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

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

  1531.   </tr>

  1532. </table>

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

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

  1535. 

  1536. </div>

  1537. </div>

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

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

  1540. 

  1541. <div class="memitem">

  1542. <div class="memproto">

  1543. <table class="mlabels">

  1544.   <tr>

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

  1546.       <table class="memname">

  1547.         <tr>

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

  1549.           <td>(</td>

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

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

  1552.           <td></td>

  1553.         </tr>

  1554.       </table>

  1555.   </td>

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

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

  1558.   </tr>

  1559. </table>

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

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

  1562.   <table class="params">

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

  1564.   </table>

  1565.   </dd>

  1566. </dl>

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

  1568. 

  1569. </div>

  1570. </div>

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

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

  1573. 

  1574. <div class="memitem">

  1575. <div class="memproto">

  1576. <table class="mlabels">

  1577.   <tr>

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

  1579.       <table class="memname">

  1580.         <tr>

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

  1582.           <td>(</td>

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

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

  1585.         </tr>

  1586.         <tr>

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

  1588.           <td></td>

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

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

  1591.         </tr>

  1592.         <tr>

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

  1594.           <td></td>

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

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

  1597.         </tr>

  1598.         <tr>

  1599.           <td></td>

  1600.           <td>)</td>

  1601.           <td></td><td></td>

  1602.         </tr>

  1603.       </table>

  1604.   </td>

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

  1606. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1607.   </tr>

  1608. </table>

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

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

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

  1612.   <table class="params">

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

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

  1615.   </table>

  1616.   </dd>

  1617. </dl>

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

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

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

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

  1622.   <table class="params">

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

  1624.   </table>

  1625.   </dd>

  1626. </dl>

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

  1628. 

  1629. </div>

  1630. </div>

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

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

  1633. 

  1634. <div class="memitem">

  1635. <div class="memproto">

  1636. <table class="mlabels">

  1637.   <tr>

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

  1639.       <table class="memname">

  1640.         <tr>

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

  1642.           <td>(</td>

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

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

  1645.           <td></td>

  1646.         </tr>

  1647.       </table>

  1648.   </td>

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

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

  1651.   </tr>

  1652. </table>

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

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

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

  1656.   <table class="params">

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

  1658.   </table>

  1659.   </dd>

  1660. </dl>

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

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

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

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

  1665. 

  1666. </div>

  1667. </div>

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

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

  1670. 

  1671. <div class="memitem">

  1672. <div class="memproto">

  1673. <table class="mlabels">

  1674.   <tr>

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

  1676.       <table class="memname">

  1677.         <tr>

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

  1679.           <td>(</td>

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

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

  1682.         </tr>

  1683.         <tr>

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

  1685.           <td></td>

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

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

  1688.         </tr>

  1689.         <tr>

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

  1691.           <td></td>

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

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

  1694.         </tr>

  1695.         <tr>

  1696.           <td></td>

  1697.           <td>)</td>

  1698.           <td></td><td></td>

  1699.         </tr>

  1700.       </table>

  1701.   </td>

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

  1703. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1704.   </tr>

  1705. </table>

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

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

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

  1709.   <table class="params">

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

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

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

  1713.   </table>

  1714.   </dd>

  1715. </dl>

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

  1717. 

  1718. </div>

  1719. </div>

  1720. <a id="a8792c863080576eb65ce6cacbe1dd931"></a>

  1721. <h2 class="memtitle"><span class="permalink"><a href="#a8792c863080576eb65ce6cacbe1dd931">&#9670;&nbsp;</a></span>name()</h2>

  1722. 

  1723. <div class="memitem">

  1724. <div class="memproto">

  1725. <table class="mlabels">

  1726.   <tr>

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

  1728.       <table class="memname">

  1729.         <tr>

  1730.           <td class="memname">const char* <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::name </td>

  1731.           <td>(</td>

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

  1733.           <td> const</td>

  1734.         </tr>

  1735.       </table>

  1736.   </td>

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

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

  1739.   </tr>

  1740. </table>

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

  1742. <p>No longer implemented due to Long File Names.</p>

  1743. <p>Use <a class="el" href="class_fat_file.html#aafa565e286440aab612cdb430fc01da5">getName(char* name, size_t size)</a>. </p><dl class="section return"><dt>Returns</dt><dd>a pointer to replacement suggestion. </dd></dl>

  1744. 

  1745. </div>

  1746. </div>

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

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

  1749. 

  1750. <div class="memitem">

  1751. <div class="memproto">

  1752. <table class="mlabels">

  1753.   <tr>

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

  1755.       <table class="memname">

  1756.         <tr>

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

  1758.           <td>(</td>

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

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

  1761.         </tr>

  1762.         <tr>

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

  1764.           <td></td>

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

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

  1767.         </tr>

  1768.         <tr>

  1769.           <td></td>

  1770.           <td>)</td>

  1771.           <td></td><td></td>

  1772.         </tr>

  1773.       </table>

  1774.   </td>

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

  1776. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1777.   </tr>

  1778. </table>

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

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

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

  1782.   <table class="params">

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

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

  1785.   </table>

  1786.   </dd>

  1787. </dl>

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

  1789. 

  1790. </div>

  1791. </div>

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

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

  1794. 

  1795. <div class="memitem">

  1796. <div class="memproto">

  1797. <table class="mlabels">

  1798.   <tr>

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

  1800.       <table class="memname">

  1801.         <tr>

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

  1803.           <td>(</td>

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

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

  1806.         </tr>

  1807.         <tr>

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

  1809.           <td></td>

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

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

  1812.         </tr>

  1813.         <tr>

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

  1815.           <td></td>

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

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

  1818.         </tr>

  1819.         <tr>

  1820.           <td></td>

  1821.           <td>)</td>

  1822.           <td></td><td></td>

  1823.         </tr>

  1824.       </table>

  1825.   </td>

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

  1827. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1828.   </tr>

  1829. </table>

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

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

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

  1833.   <table class="params">

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

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

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

  1837.   </table>

  1838.   </dd>

  1839. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

  1853. 

  1854. </div>

  1855. </div>

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

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

  1858. 

  1859. <div class="memitem">

  1860. <div class="memproto">

  1861. <table class="mlabels">

  1862.   <tr>

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

  1864.       <table class="memname">

  1865.         <tr>

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

  1867.           <td>(</td>

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

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

  1870.         </tr>

  1871.         <tr>

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

  1873.           <td></td>

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

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

  1876.         </tr>

  1877.         <tr>

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

  1879.           <td></td>

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

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

  1882.         </tr>

  1883.         <tr>

  1884.           <td></td>

  1885.           <td>)</td>

  1886.           <td></td><td></td>

  1887.         </tr>

  1888.       </table>

  1889.   </td>

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

  1891. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1892.   </tr>

  1893. </table>

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

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

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

  1897.   <table class="params">

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

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

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

  1901.   </table>

  1902.   </dd>

  1903. </dl>

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

  1905. 

  1906. </div>

  1907. </div>

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

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

  1910. 

  1911. <div class="memitem">

  1912. <div class="memproto">

  1913. <table class="mlabels">

  1914.   <tr>

  1915.   <td class="mlabels-left">

  1916.       <table class="memname">

  1917.         <tr>

  1918.           <td class="memname">bool FatFile::open </td>

  1919.           <td>(</td>

  1920.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1921.           <td class="paramname"><em>vol</em>, </td>

  1922.         </tr>

  1923.         <tr>

  1924.           <td class="paramkey"></td>

  1925.           <td></td>

  1926.           <td class="paramtype">const char *&#160;</td>

  1927.           <td class="paramname"><em>path</em>, </td>

  1928.         </tr>

  1929.         <tr>

  1930.           <td class="paramkey"></td>

  1931.           <td></td>

  1932.           <td class="paramtype">oflag_t&#160;</td>

  1933.           <td class="paramname"><em>oflag</em>&#160;</td>

  1934.         </tr>

  1935.         <tr>

  1936.           <td></td>

  1937.           <td>)</td>

  1938.           <td></td><td></td>

  1939.         </tr>

  1940.       </table>

  1941.   </td>

  1942.   <td class="mlabels-right">

  1943. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1944.   </tr>

  1945. </table>

  1946. </div><div class="memdoc">

  1947. <p>Open a file in the volume root directory.</p>

  1948. <dl class="params"><dt>Parameters</dt><dd>

  1949.   <table class="params">

  1950.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>

  1951.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid name for a file to be opened.</td></tr>

  1952.     <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>

  1953.   </table>

  1954.   </dd>

  1955. </dl>

  1956. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1957. 

  1958. </div>

  1959. </div>

  1960. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>

  1961. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>

  1962. 

  1963. <div class="memitem">

  1964. <div class="memproto">

  1965. <table class="mlabels">

  1966.   <tr>

  1967.   <td class="mlabels-left">

  1968.       <table class="memname">

  1969.         <tr>

  1970.           <td class="memname">bool FatFile::openNext </td>

  1971.           <td>(</td>

  1972.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1973.           <td class="paramname"><em>dirFile</em>, </td>

  1974.         </tr>

  1975.         <tr>

  1976.           <td class="paramkey"></td>

  1977.           <td></td>

  1978.           <td class="paramtype">oflag_t&#160;</td>

  1979.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1980.         </tr>

  1981.         <tr>

  1982.           <td></td>

  1983.           <td>)</td>

  1984.           <td></td><td></td>

  1985.         </tr>

  1986.       </table>

  1987.   </td>

  1988.   <td class="mlabels-right">

  1989. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1990.   </tr>

  1991. </table>

  1992. </div><div class="memdoc">

  1993. <p>Open the next file or subdirectory in a directory.</p>

  1994. <dl class="params"><dt>Parameters</dt><dd>

  1995.   <table class="params">

  1996.     <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>

  1997.     <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>

  1998.   </table>

  1999.   </dd>

  2000. </dl>

  2001. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2002. 

  2003. </div>

  2004. </div>

  2005. <a id="a571434707124ee554d659ec82e2ef750"></a>

  2006. <h2 class="memtitle"><span class="permalink"><a href="#a571434707124ee554d659ec82e2ef750">&#9670;&nbsp;</a></span>openNextFile()</h2>

  2007. 

  2008. <div class="memitem">

  2009. <div class="memproto">

  2010. <table class="mlabels">

  2011.   <tr>

  2012.   <td class="mlabels-left">

  2013.       <table class="memname">

  2014.         <tr>

  2015.           <td class="memname"><a class="el" href="class_file32.html">File32</a> File32::openNextFile </td>

  2016.           <td>(</td>

  2017.           <td class="paramtype">oflag_t&#160;</td>

  2018.           <td class="paramname"><em>oflag</em> = <code>0X00</code></td><td>)</td>

  2019.           <td></td>

  2020.         </tr>

  2021.       </table>

  2022.   </td>

  2023.   <td class="mlabels-right">

  2024. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2025.   </tr>

  2026. </table>

  2027. </div><div class="memdoc">

  2028. <p>Opens the next file or folder in a directory.</p>

  2029. <dl class="params"><dt>Parameters</dt><dd>

  2030.   <table class="params">

  2031.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>

  2032.   </table>

  2033.   </dd>

  2034. </dl>

  2035. <dl class="section return"><dt>Returns</dt><dd>a FatStream object. </dd></dl>

  2036. 

  2037. </div>

  2038. </div>

  2039. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  2040. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</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">bool FatFile::openRoot </td>

  2050.           <td>(</td>

  2051.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  2052.           <td class="paramname"><em>vol</em></td><td>)</td>

  2053.           <td></td>

  2054.         </tr>

  2055.       </table>

  2056.   </td>

  2057.   <td class="mlabels-right">

  2058. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2059.   </tr>

  2060. </table>

  2061. </div><div class="memdoc">

  2062. <p>Open a volume's root directory.</p>

  2063. <dl class="params"><dt>Parameters</dt><dd>

  2064.   <table class="params">

  2065.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  2066.   </table>

  2067.   </dd>

  2068. </dl>

  2069. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2070. 

  2071. </div>

  2072. </div>

  2073. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>

  2074. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>

  2075. 

  2076. <div class="memitem">

  2077. <div class="memproto">

  2078. <table class="mlabels">

  2079.   <tr>

  2080.   <td class="mlabels-left">

  2081.       <table class="memname">

  2082.         <tr>

  2083.           <td class="memname">FatFile::operator bool </td>

  2084.           <td>(</td>

  2085.           <td class="paramname"></td><td>)</td>

  2086.           <td></td>

  2087.         </tr>

  2088.       </table>

  2089.   </td>

  2090.   <td class="mlabels-right">

  2091. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2092.   </tr>

  2093. </table>

  2094. </div><div class="memdoc">

  2095. <p>The parenthesis operator.</p>

  2096. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  2097. 

  2098. </div>

  2099. </div>

  2100. <a id="af0da96e502485133ca0cff27fa130082"></a>

  2101. <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">&#9670;&nbsp;</a></span>peek()</h2>

  2102. 

  2103. <div class="memitem">

  2104. <div class="memproto">

  2105. <table class="mlabels">

  2106.   <tr>

  2107.   <td class="mlabels-left">

  2108.       <table class="memname">

  2109.         <tr>

  2110.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::peek </td>

  2111.           <td>(</td>

  2112.           <td class="paramname"></td><td>)</td>

  2113.           <td></td>

  2114.         </tr>

  2115.       </table>

  2116.   </td>

  2117.   <td class="mlabels-right">

  2118. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2119.   </tr>

  2120. </table>

  2121. </div><div class="memdoc">

  2122. <p>Return the next available byte without consuming it.</p>

  2123. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  2124. 

  2125. </div>

  2126. </div>

  2127. <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>

  2128. <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">&#9670;&nbsp;</a></span>position()</h2>

  2129. 

  2130. <div class="memitem">

  2131. <div class="memproto">

  2132. <table class="mlabels">

  2133.   <tr>

  2134.   <td class="mlabels-left">

  2135.       <table class="memname">

  2136.         <tr>

  2137.           <td class="memname">uint32_t  <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::position </td>

  2138.           <td>(</td>

  2139.           <td class="paramname"></td><td>)</td>

  2140.           <td></td>

  2141.         </tr>

  2142.       </table>

  2143.   </td>

  2144.   <td class="mlabels-right">

  2145. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2146.   </tr>

  2147. </table>

  2148. </div><div class="memdoc">

  2149. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  2150. 

  2151. </div>

  2152. </div>

  2153. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>

  2154. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>

  2155. 

  2156. <div class="memitem">

  2157. <div class="memproto">

  2158. <table class="mlabels">

  2159.   <tr>

  2160.   <td class="mlabels-left">

  2161.       <table class="memname">

  2162.         <tr>

  2163.           <td class="memname">bool FatFile::preAllocate </td>

  2164.           <td>(</td>

  2165.           <td class="paramtype">uint32_t&#160;</td>

  2166.           <td class="paramname"><em>length</em></td><td>)</td>

  2167.           <td></td>

  2168.         </tr>

  2169.       </table>

  2170.   </td>

  2171.   <td class="mlabels-right">

  2172. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2173.   </tr>

  2174. </table>

  2175. </div><div class="memdoc">

  2176. <p>Allocate contiguous clusters to an empty file.</p>

  2177. <p>The file must be empty with no clusters allocated.</p>

  2178. <p>The file will contain uninitialized data.</p>

  2179. <dl class="params"><dt>Parameters</dt><dd>

  2180.   <table class="params">

  2181.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  2182.   </table>

  2183.   </dd>

  2184. </dl>

  2185. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2186. 

  2187. </div>

  2188. </div>

  2189. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>

  2190. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>

  2191. 

  2192. <div class="memitem">

  2193. <div class="memproto">

  2194. <table class="mlabels">

  2195.   <tr>

  2196.   <td class="mlabels-left">

  2197.       <table class="memname">

  2198.         <tr>

  2199.           <td class="memname">size_t FatFile::printAccessDate </td>

  2200.           <td>(</td>

  2201.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2202.           <td class="paramname"><em>pr</em></td><td>)</td>

  2203.           <td></td>

  2204.         </tr>

  2205.       </table>

  2206.   </td>

  2207.   <td class="mlabels-right">

  2208. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2209.   </tr>

  2210. </table>

  2211. </div><div class="memdoc">

  2212. <p>Print a file's access date</p>

  2213. <dl class="params"><dt>Parameters</dt><dd>

  2214.   <table class="params">

  2215.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2216.   </table>

  2217.   </dd>

  2218. </dl>

  2219. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2220. 

  2221. </div>

  2222. </div>

  2223. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>

  2224. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>

  2225. 

  2226. <div class="memitem">

  2227. <div class="memproto">

  2228. <table class="mlabels">

  2229.   <tr>

  2230.   <td class="mlabels-left">

  2231.       <table class="memname">

  2232.         <tr>

  2233.           <td class="memname">size_t FatFile::printAccessDateTime </td>

  2234.           <td>(</td>

  2235.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2236.           <td class="paramname"><em>pr</em></td><td>)</td>

  2237.           <td></td>

  2238.         </tr>

  2239.       </table>

  2240.   </td>

  2241.   <td class="mlabels-right">

  2242. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2243.   </tr>

  2244. </table>

  2245. </div><div class="memdoc">

  2246. <p>Print a file's access date</p>

  2247. <dl class="params"><dt>Parameters</dt><dd>

  2248.   <table class="params">

  2249.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2250.   </table>

  2251.   </dd>

  2252. </dl>

  2253. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2254. 

  2255. </div>

  2256. </div>

  2257. <a id="ab22396a285e27b53501a0047ddd97f59"></a>

  2258. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  2259. 

  2260. <div class="memitem">

  2261. <div class="memproto">

  2262. <table class="mlabels">

  2263.   <tr>

  2264.   <td class="mlabels-left">

  2265.       <table class="memname">

  2266.         <tr>

  2267.           <td class="memname">size_t FatFile::printCreateDateTime </td>

  2268.           <td>(</td>

  2269.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2270.           <td class="paramname"><em>pr</em></td><td>)</td>

  2271.           <td></td>

  2272.         </tr>

  2273.       </table>

  2274.   </td>

  2275.   <td class="mlabels-right">

  2276. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2277.   </tr>

  2278. </table>

  2279. </div><div class="memdoc">

  2280. <p>Print a file's creation date and time</p>

  2281. <dl class="params"><dt>Parameters</dt><dd>

  2282.   <table class="params">

  2283.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2284.   </table>

  2285.   </dd>

  2286. </dl>

  2287. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  2288. 

  2289. </div>

  2290. </div>

  2291. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>

  2292. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>

  2293. 

  2294. <div class="memitem">

  2295. <div class="memproto">

  2296. <table class="mlabels">

  2297.   <tr>

  2298.   <td class="mlabels-left">

  2299.       <table class="memname">

  2300.         <tr>

  2301.           <td class="memname">static void FatFile::printFatDate </td>

  2302.           <td>(</td>

  2303.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2304.           <td class="paramname"><em>pr</em>, </td>

  2305.         </tr>

  2306.         <tr>

  2307.           <td class="paramkey"></td>

  2308.           <td></td>

  2309.           <td class="paramtype">uint16_t&#160;</td>

  2310.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2311.         </tr>

  2312.         <tr>

  2313.           <td></td>

  2314.           <td>)</td>

  2315.           <td></td><td></td>

  2316.         </tr>

  2317.       </table>

  2318.   </td>

  2319.   <td class="mlabels-right">

  2320. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2321.   </tr>

  2322. </table>

  2323. </div><div class="memdoc">

  2324. <p>Print a directory date field.</p>

  2325. <p>Format is yyyy-mm-dd.</p>

  2326. <dl class="params"><dt>Parameters</dt><dd>

  2327.   <table class="params">

  2328.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2329.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2330.   </table>

  2331.   </dd>

  2332. </dl>

  2333. 

  2334. </div>

  2335. </div>

  2336. <a id="a7f84d953190ea94710dad9ebb897b957"></a>

  2337. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>

  2338. 

  2339. <div class="memitem">

  2340. <div class="memproto">

  2341. <table class="mlabels">

  2342.   <tr>

  2343.   <td class="mlabels-left">

  2344.       <table class="memname">

  2345.         <tr>

  2346.           <td class="memname">static void FatFile::printFatTime </td>

  2347.           <td>(</td>

  2348.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2349.           <td class="paramname"><em>pr</em>, </td>

  2350.         </tr>

  2351.         <tr>

  2352.           <td class="paramkey"></td>

  2353.           <td></td>

  2354.           <td class="paramtype">uint16_t&#160;</td>

  2355.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2356.         </tr>

  2357.         <tr>

  2358.           <td></td>

  2359.           <td>)</td>

  2360.           <td></td><td></td>

  2361.         </tr>

  2362.       </table>

  2363.   </td>

  2364.   <td class="mlabels-right">

  2365. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2366.   </tr>

  2367. </table>

  2368. </div><div class="memdoc">

  2369. <p>Print a directory time field.</p>

  2370. <p>Format is hh:mm:ss.</p>

  2371. <dl class="params"><dt>Parameters</dt><dd>

  2372.   <table class="params">

  2373.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2374.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2375.   </table>

  2376.   </dd>

  2377. </dl>

  2378. 

  2379. </div>

  2380. </div>

  2381. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>

  2382. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  2383. 

  2384. <div class="memitem">

  2385. <div class="memproto">

  2386. <table class="mlabels">

  2387.   <tr>

  2388.   <td class="mlabels-left">

  2389.       <table class="memname">

  2390.         <tr>

  2391.           <td class="memname">size_t FatFile::printField </td>

  2392.           <td>(</td>

  2393.           <td class="paramtype">double&#160;</td>

  2394.           <td class="paramname"><em>value</em>, </td>

  2395.         </tr>

  2396.         <tr>

  2397.           <td class="paramkey"></td>

  2398.           <td></td>

  2399.           <td class="paramtype">char&#160;</td>

  2400.           <td class="paramname"><em>term</em>, </td>

  2401.         </tr>

  2402.         <tr>

  2403.           <td class="paramkey"></td>

  2404.           <td></td>

  2405.           <td class="paramtype">uint8_t&#160;</td>

  2406.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2407.         </tr>

  2408.         <tr>

  2409.           <td></td>

  2410.           <td>)</td>

  2411.           <td></td><td></td>

  2412.         </tr>

  2413.       </table>

  2414.   </td>

  2415.   <td class="mlabels-right">

  2416. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2417.   </tr>

  2418. </table>

  2419. </div><div class="memdoc">

  2420. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2421.   <table class="params">

  2422.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2423.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2424.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2425.   </table>

  2426.   </dd>

  2427. </dl>

  2428. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2429. 

  2430. </div>

  2431. </div>

  2432. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>

  2433. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  2434. 

  2435. <div class="memitem">

  2436. <div class="memproto">

  2437. <table class="mlabels">

  2438.   <tr>

  2439.   <td class="mlabels-left">

  2440.       <table class="memname">

  2441.         <tr>

  2442.           <td class="memname">size_t FatFile::printField </td>

  2443.           <td>(</td>

  2444.           <td class="paramtype">float&#160;</td>

  2445.           <td class="paramname"><em>value</em>, </td>

  2446.         </tr>

  2447.         <tr>

  2448.           <td class="paramkey"></td>

  2449.           <td></td>

  2450.           <td class="paramtype">char&#160;</td>

  2451.           <td class="paramname"><em>term</em>, </td>

  2452.         </tr>

  2453.         <tr>

  2454.           <td class="paramkey"></td>

  2455.           <td></td>

  2456.           <td class="paramtype">uint8_t&#160;</td>

  2457.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2458.         </tr>

  2459.         <tr>

  2460.           <td></td>

  2461.           <td>)</td>

  2462.           <td></td><td></td>

  2463.         </tr>

  2464.       </table>

  2465.   </td>

  2466.   <td class="mlabels-right">

  2467. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2468.   </tr>

  2469. </table>

  2470. </div><div class="memdoc">

  2471. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2472.   <table class="params">

  2473.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2474.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2475.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2476.   </table>

  2477.   </dd>

  2478. </dl>

  2479. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2480. 

  2481. </div>

  2482. </div>

  2483. <a id="a8f906be79086f38943cb0911310d67bf"></a>

  2484. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  2485. 

  2486. <div class="memitem">

  2487. <div class="memproto">

  2488. <div class="memtemplate">

  2489. template&lt;typename Type &gt; </div>

  2490. <table class="mlabels">

  2491.   <tr>

  2492.   <td class="mlabels-left">

  2493.       <table class="memname">

  2494.         <tr>

  2495.           <td class="memname">size_t FatFile::printField </td>

  2496.           <td>(</td>

  2497.           <td class="paramtype">Type&#160;</td>

  2498.           <td class="paramname"><em>value</em>, </td>

  2499.         </tr>

  2500.         <tr>

  2501.           <td class="paramkey"></td>

  2502.           <td></td>

  2503.           <td class="paramtype">char&#160;</td>

  2504.           <td class="paramname"><em>term</em>&#160;</td>

  2505.         </tr>

  2506.         <tr>

  2507.           <td></td>

  2508.           <td>)</td>

  2509.           <td></td><td></td>

  2510.         </tr>

  2511.       </table>

  2512.   </td>

  2513.   <td class="mlabels-right">

  2514. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2515.   </tr>

  2516. </table>

  2517. </div><div class="memdoc">

  2518. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2519.   <table class="params">

  2520.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2521.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2522.   </table>

  2523.   </dd>

  2524. </dl>

  2525. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2526. 

  2527. </div>

  2528. </div>

  2529. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2530. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>

  2531. 

  2532. <div class="memitem">

  2533. <div class="memproto">

  2534. <table class="mlabels">

  2535.   <tr>

  2536.   <td class="mlabels-left">

  2537.       <table class="memname">

  2538.         <tr>

  2539.           <td class="memname">size_t FatFile::printFileSize </td>

  2540.           <td>(</td>

  2541.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2542.           <td class="paramname"><em>pr</em></td><td>)</td>

  2543.           <td></td>

  2544.         </tr>

  2545.       </table>

  2546.   </td>

  2547.   <td class="mlabels-right">

  2548. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2549.   </tr>

  2550. </table>

  2551. </div><div class="memdoc">

  2552. <p>Print a file's size.</p>

  2553. <dl class="params"><dt>Parameters</dt><dd>

  2554.   <table class="params">

  2555.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2556.   </table>

  2557.   </dd>

  2558. </dl>

  2559. <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>

  2560. 

  2561. </div>

  2562. </div>

  2563. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>

  2564. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>

  2565. 

  2566. <div class="memitem">

  2567. <div class="memproto">

  2568. <table class="mlabels">

  2569.   <tr>

  2570.   <td class="mlabels-left">

  2571.       <table class="memname">

  2572.         <tr>

  2573.           <td class="memname">size_t FatFile::printModifyDateTime </td>

  2574.           <td>(</td>

  2575.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2576.           <td class="paramname"><em>pr</em></td><td>)</td>

  2577.           <td></td>

  2578.         </tr>

  2579.       </table>

  2580.   </td>

  2581.   <td class="mlabels-right">

  2582. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2583.   </tr>

  2584. </table>

  2585. </div><div class="memdoc">

  2586. <p>Print a file's modify date and time</p>

  2587. <dl class="params"><dt>Parameters</dt><dd>

  2588.   <table class="params">

  2589.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2590.   </table>

  2591.   </dd>

  2592. </dl>

  2593. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2594. 

  2595. </div>

  2596. </div>

  2597. <a id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2598. <h2 class="memtitle"><span class="permalink"><a href="#ad1cbc3aeb0f5193b7a26595966da9621">&#9670;&nbsp;</a></span>printName() <span class="overload">[1/2]</span></h2>

  2599. 

  2600. <div class="memitem">

  2601. <div class="memproto">

  2602. <table class="mlabels">

  2603.   <tr>

  2604.   <td class="mlabels-left">

  2605.       <table class="memname">

  2606.         <tr>

  2607.           <td class="memname">size_t FatFile::printName </td>

  2608.           <td>(</td>

  2609.           <td class="paramname"></td><td>)</td>

  2610.           <td></td>

  2611.         </tr>

  2612.       </table>

  2613.   </td>

  2614.   <td class="mlabels-right">

  2615. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2616.   </tr>

  2617. </table>

  2618. </div><div class="memdoc">

  2619. <p>Print a file's name.</p>

  2620. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2621. 

  2622. </div>

  2623. </div>

  2624. <a id="afe18a787fb8640e2d2483370c770f82f"></a>

  2625. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName() <span class="overload">[2/2]</span></h2>

  2626. 

  2627. <div class="memitem">

  2628. <div class="memproto">

  2629. <table class="mlabels">

  2630.   <tr>

  2631.   <td class="mlabels-left">

  2632.       <table class="memname">

  2633.         <tr>

  2634.           <td class="memname">size_t FatFile::printName </td>

  2635.           <td>(</td>

  2636.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2637.           <td class="paramname"><em>pr</em></td><td>)</td>

  2638.           <td></td>

  2639.         </tr>

  2640.       </table>

  2641.   </td>

  2642.   <td class="mlabels-right">

  2643. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2644.   </tr>

  2645. </table>

  2646. </div><div class="memdoc">

  2647. <p>Print a file's name</p>

  2648. <dl class="params"><dt>Parameters</dt><dd>

  2649.   <table class="params">

  2650.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2651.   </table>

  2652.   </dd>

  2653. </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="a791cd7aade71f609aab62ec018aea3c0"></a>

  2659. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>

  2660. 

  2661. <div class="memitem">

  2662. <div class="memproto">

  2663. <table class="mlabels">

  2664.   <tr>

  2665.   <td class="mlabels-left">

  2666.       <table class="memname">

  2667.         <tr>

  2668.           <td class="memname">size_t FatFile::printSFN </td>

  2669.           <td>(</td>

  2670.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2671.           <td class="paramname"><em>pr</em></td><td>)</td>

  2672.           <td></td>

  2673.         </tr>

  2674.       </table>

  2675.   </td>

  2676.   <td class="mlabels-right">

  2677. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2678.   </tr>

  2679. </table>

  2680. </div><div class="memdoc">

  2681. <p>Print a file's Short File Name.</p>

  2682. <dl class="params"><dt>Parameters</dt><dd>

  2683.   <table class="params">

  2684.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2685.   </table>

  2686.   </dd>

  2687. </dl>

  2688. <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>

  2689. 

  2690. </div>

  2691. </div>

  2692. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>

  2693. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  2694. 

  2695. <div class="memitem">

  2696. <div class="memproto">

  2697. <table class="mlabels">

  2698.   <tr>

  2699.   <td class="mlabels-left">

  2700.       <table class="memname">

  2701.         <tr>

  2702.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::read </td>

  2703.           <td>(</td>

  2704.           <td class="paramname"></td><td>)</td>

  2705.           <td></td>

  2706.         </tr>

  2707.       </table>

  2708.   </td>

  2709.   <td class="mlabels-right">

  2710. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2711.   </tr>

  2712. </table>

  2713. </div><div class="memdoc">

  2714. <p>Read the next byte from a file.</p>

  2715. <dl class="section return"><dt>Returns</dt><dd>For success return the next byte in the file as an int. If an error occurs or end of file is reached return -1. </dd></dl>

  2716. 

  2717. </div>

  2718. </div>

  2719. <a id="aba893af8107a18017482d2311b066187"></a>

  2720. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2721. 

  2722. <div class="memitem">

  2723. <div class="memproto">

  2724. <table class="mlabels">

  2725.   <tr>

  2726.   <td class="mlabels-left">

  2727.       <table class="memname">

  2728.         <tr>

  2729.           <td class="memname">int FatFile::read </td>

  2730.           <td>(</td>

  2731.           <td class="paramtype">void *&#160;</td>

  2732.           <td class="paramname"><em>buf</em>, </td>

  2733.         </tr>

  2734.         <tr>

  2735.           <td class="paramkey"></td>

  2736.           <td></td>

  2737.           <td class="paramtype">size_t&#160;</td>

  2738.           <td class="paramname"><em>count</em>&#160;</td>

  2739.         </tr>

  2740.         <tr>

  2741.           <td></td>

  2742.           <td>)</td>

  2743.           <td></td><td></td>

  2744.         </tr>

  2745.       </table>

  2746.   </td>

  2747.   <td class="mlabels-right">

  2748. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2749.   </tr>

  2750. </table>

  2751. </div><div class="memdoc">

  2752. <p>Read data from a file starting at the current position.</p>

  2753. <dl class="params"><dt>Parameters</dt><dd>

  2754.   <table class="params">

  2755.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2756.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2757.   </table>

  2758.   </dd>

  2759. </dl>

  2760. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_stream_file.html#a249a5d428f303e2a8e7c3ae476e74829">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_stream_file.html#a249a5d428f303e2a8e7c3ae476e74829">read()</a> returns -1. </dd></dl>

  2761. 

  2762. </div>

  2763. </div>

  2764. <a id="a29502cd34ef186763d2196daef27df1f"></a>

  2765. <h2 class="memtitle"><span class="permalink"><a href="#a29502cd34ef186763d2196daef27df1f">&#9670;&nbsp;</a></span>readDir()</h2>

  2766. 

  2767. <div class="memitem">

  2768. <div class="memproto">

  2769. <table class="mlabels">

  2770.   <tr>

  2771.   <td class="mlabels-left">

  2772.       <table class="memname">

  2773.         <tr>

  2774.           <td class="memname">int8_t FatFile::readDir </td>

  2775.           <td>(</td>

  2776.           <td class="paramtype">DirFat_t *&#160;</td>

  2777.           <td class="paramname"><em>dir</em></td><td>)</td>

  2778.           <td></td>

  2779.         </tr>

  2780.       </table>

  2781.   </td>

  2782.   <td class="mlabels-right">

  2783. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2784.   </tr>

  2785. </table>

  2786. </div><div class="memdoc">

  2787. <p>Read the next directory entry from a directory file.</p>

  2788. <dl class="params"><dt>Parameters</dt><dd>

  2789.   <table class="params">

  2790.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The DirFat_t struct that will receive the data.</td></tr>

  2791.   </table>

  2792.   </dd>

  2793. </dl>

  2794. <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>

  2795. 

  2796. </div>

  2797. </div>

  2798. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2799. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2800. 

  2801. <div class="memitem">

  2802. <div class="memproto">

  2803. <table class="mlabels">

  2804.   <tr>

  2805.   <td class="mlabels-left">

  2806.       <table class="memname">

  2807.         <tr>

  2808.           <td class="memname">bool FatFile::remove </td>

  2809.           <td>(</td>

  2810.           <td class="paramname"></td><td>)</td>

  2811.           <td></td>

  2812.         </tr>

  2813.       </table>

  2814.   </td>

  2815.   <td class="mlabels-right">

  2816. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2817.   </tr>

  2818. </table>

  2819. </div><div class="memdoc">

  2820. <p>Remove a file.</p>

  2821. <p>The directory entry and all data for the file are deleted.</p>

  2822. <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>

  2823. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2824. 

  2825. </div>

  2826. </div>

  2827. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>

  2828. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2829. 

  2830. <div class="memitem">

  2831. <div class="memproto">

  2832. <table class="mlabels">

  2833.   <tr>

  2834.   <td class="mlabels-left">

  2835.       <table class="memname">

  2836.         <tr>

  2837.           <td class="memname">bool FatFile::remove </td>

  2838.           <td>(</td>

  2839.           <td class="paramtype">const char *&#160;</td>

  2840.           <td class="paramname"><em>path</em></td><td>)</td>

  2841.           <td></td>

  2842.         </tr>

  2843.       </table>

  2844.   </td>

  2845.   <td class="mlabels-right">

  2846. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2847.   </tr>

  2848. </table>

  2849. </div><div class="memdoc">

  2850. <p>Remove a file.</p>

  2851. <p>The directory entry and all data for the file are deleted.</p>

  2852. <dl class="params"><dt>Parameters</dt><dd>

  2853.   <table class="params">

  2854.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2855.   </table>

  2856.   </dd>

  2857. </dl>

  2858. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2859. <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>

  2860. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2861. 

  2862. </div>

  2863. </div>

  2864. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>

  2865. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2866. 

  2867. <div class="memitem">

  2868. <div class="memproto">

  2869. <table class="mlabels">

  2870.   <tr>

  2871.   <td class="mlabels-left">

  2872.       <table class="memname">

  2873.         <tr>

  2874.           <td class="memname">bool FatFile::rename </td>

  2875.           <td>(</td>

  2876.           <td class="paramtype">const char *&#160;</td>

  2877.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2878.           <td></td>

  2879.         </tr>

  2880.       </table>

  2881.   </td>

  2882.   <td class="mlabels-right">

  2883. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2884.   </tr>

  2885. </table>

  2886. </div><div class="memdoc">

  2887. <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>

  2888. <dl class="params"><dt>Parameters</dt><dd>

  2889.   <table class="params">

  2890.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2891.   </table>

  2892.   </dd>

  2893. </dl>

  2894. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2895. 

  2896. </div>

  2897. </div>

  2898. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2899. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2900. 

  2901. <div class="memitem">

  2902. <div class="memproto">

  2903. <table class="mlabels">

  2904.   <tr>

  2905.   <td class="mlabels-left">

  2906.       <table class="memname">

  2907.         <tr>

  2908.           <td class="memname">bool FatFile::rename </td>

  2909.           <td>(</td>

  2910.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2911.           <td class="paramname"><em>dirFile</em>, </td>

  2912.         </tr>

  2913.         <tr>

  2914.           <td class="paramkey"></td>

  2915.           <td></td>

  2916.           <td class="paramtype">const char *&#160;</td>

  2917.           <td class="paramname"><em>newPath</em>&#160;</td>

  2918.         </tr>

  2919.         <tr>

  2920.           <td></td>

  2921.           <td>)</td>

  2922.           <td></td><td></td>

  2923.         </tr>

  2924.       </table>

  2925.   </td>

  2926.   <td class="mlabels-right">

  2927. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2928.   </tr>

  2929. </table>

  2930. </div><div class="memdoc">

  2931. <p>Rename a file or subdirectory.</p>

  2932. <dl class="params"><dt>Parameters</dt><dd>

  2933.   <table class="params">

  2934.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2935.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2936.   </table>

  2937.   </dd>

  2938. </dl>

  2939. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2940. 

  2941. </div>

  2942. </div>

  2943. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2944. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>

  2945. 

  2946. <div class="memitem">

  2947. <div class="memproto">

  2948. <table class="mlabels">

  2949.   <tr>

  2950.   <td class="mlabels-left">

  2951.       <table class="memname">

  2952.         <tr>

  2953.           <td class="memname">void FatFile::rewind </td>

  2954.           <td>(</td>

  2955.           <td class="paramname"></td><td>)</td>

  2956.           <td></td>

  2957.         </tr>

  2958.       </table>

  2959.   </td>

  2960.   <td class="mlabels-right">

  2961. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2962.   </tr>

  2963. </table>

  2964. </div><div class="memdoc">

  2965. <p>Set the file's current position to zero. </p>

  2966. 

  2967. </div>

  2968. </div>

  2969. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  2970. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  2971. 

  2972. <div class="memitem">

  2973. <div class="memproto">

  2974. <table class="mlabels">

  2975.   <tr>

  2976.   <td class="mlabels-left">

  2977.       <table class="memname">

  2978.         <tr>

  2979.           <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::rewindDirectory </td>

  2980.           <td>(</td>

  2981.           <td class="paramname"></td><td>)</td>

  2982.           <td></td>

  2983.         </tr>

  2984.       </table>

  2985.   </td>

  2986.   <td class="mlabels-right">

  2987. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2988.   </tr>

  2989. </table>

  2990. </div><div class="memdoc">

  2991. <p>Rewind a file if it is a directory </p>

  2992. 

  2993. </div>

  2994. </div>

  2995. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2996. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>

  2997. 

  2998. <div class="memitem">

  2999. <div class="memproto">

  3000. <table class="mlabels">

  3001.   <tr>

  3002.   <td class="mlabels-left">

  3003.       <table class="memname">

  3004.         <tr>

  3005.           <td class="memname">bool FatFile::rmdir </td>

  3006.           <td>(</td>

  3007.           <td class="paramname"></td><td>)</td>

  3008.           <td></td>

  3009.         </tr>

  3010.       </table>

  3011.   </td>

  3012.   <td class="mlabels-right">

  3013. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3014.   </tr>

  3015. </table>

  3016. </div><div class="memdoc">

  3017. <p>Remove a directory file.</p>

  3018. <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>

  3019. <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>

  3020. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3021. 

  3022. </div>

  3023. </div>

  3024. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  3025. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>

  3026. 

  3027. <div class="memitem">

  3028. <div class="memproto">

  3029. <table class="mlabels">

  3030.   <tr>

  3031.   <td class="mlabels-left">

  3032.       <table class="memname">

  3033.         <tr>

  3034.           <td class="memname">bool FatFile::rmRfStar </td>

  3035.           <td>(</td>

  3036.           <td class="paramname"></td><td>)</td>

  3037.           <td></td>

  3038.         </tr>

  3039.       </table>

  3040.   </td>

  3041.   <td class="mlabels-right">

  3042. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3043.   </tr>

  3044. </table>

  3045. </div><div class="memdoc">

  3046. <p>Recursively delete a directory and all contained files.</p>

  3047. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  3048. <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>

  3049. <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>

  3050. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3051. 

  3052. </div>

  3053. </div>

  3054. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  3055. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  3056. 

  3057. <div class="memitem">

  3058. <div class="memproto">

  3059. <table class="mlabels">

  3060.   <tr>

  3061.   <td class="mlabels-left">

  3062.       <table class="memname">

  3063.         <tr>

  3064.           <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::seek </td>

  3065.           <td>(</td>

  3066.           <td class="paramtype">uint32_t&#160;</td>

  3067.           <td class="paramname"><em>pos</em></td><td>)</td>

  3068.           <td></td>

  3069.         </tr>

  3070.       </table>

  3071.   </td>

  3072.   <td class="mlabels-right">

  3073. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3074.   </tr>

  3075. </table>

  3076. </div><div class="memdoc">

  3077. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  3078. <dl class="params"><dt>Parameters</dt><dd>

  3079.   <table class="params">

  3080.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  3081.   </table>

  3082.   </dd>

  3083. </dl>

  3084. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3085. 

  3086. </div>

  3087. </div>

  3088. <a id="a5812037ea30777cc350698ad26f2c73f"></a>

  3089. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>

  3090. 

  3091. <div class="memitem">

  3092. <div class="memproto">

  3093. <table class="mlabels">

  3094.   <tr>

  3095.   <td class="mlabels-left">

  3096.       <table class="memname">

  3097.         <tr>

  3098.           <td class="memname">bool FatFile::seekCur </td>

  3099.           <td>(</td>

  3100.           <td class="paramtype">int32_t&#160;</td>

  3101.           <td class="paramname"><em>offset</em></td><td>)</td>

  3102.           <td></td>

  3103.         </tr>

  3104.       </table>

  3105.   </td>

  3106.   <td class="mlabels-right">

  3107. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3108.   </tr>

  3109. </table>

  3110. </div><div class="memdoc">

  3111. <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>

  3112.   <table class="params">

  3113.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  3114.   </table>

  3115.   </dd>

  3116. </dl>

  3117. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3118. 

  3119. </div>

  3120. </div>

  3121. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  3122. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>

  3123. 

  3124. <div class="memitem">

  3125. <div class="memproto">

  3126. <table class="mlabels">

  3127.   <tr>

  3128.   <td class="mlabels-left">

  3129.       <table class="memname">

  3130.         <tr>

  3131.           <td class="memname">bool FatFile::seekEnd </td>

  3132.           <td>(</td>

  3133.           <td class="paramtype">int32_t&#160;</td>

  3134.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  3135.           <td></td>

  3136.         </tr>

  3137.       </table>

  3138.   </td>

  3139.   <td class="mlabels-right">

  3140. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3141.   </tr>

  3142. </table>

  3143. </div><div class="memdoc">

  3144. <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>

  3145.   <table class="params">

  3146.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  3147.   </table>

  3148.   </dd>

  3149. </dl>

  3150. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3151. 

  3152. </div>

  3153. </div>

  3154. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>

  3155. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>

  3156. 

  3157. <div class="memitem">

  3158. <div class="memproto">

  3159. <table class="mlabels">

  3160.   <tr>

  3161.   <td class="mlabels-left">

  3162.       <table class="memname">

  3163.         <tr>

  3164.           <td class="memname">bool FatFile::seekSet </td>

  3165.           <td>(</td>

  3166.           <td class="paramtype">uint32_t&#160;</td>

  3167.           <td class="paramname"><em>pos</em></td><td>)</td>

  3168.           <td></td>

  3169.         </tr>

  3170.       </table>

  3171.   </td>

  3172.   <td class="mlabels-right">

  3173. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3174.   </tr>

  3175. </table>

  3176. </div><div class="memdoc">

  3177. <p>Sets a file's position.</p>

  3178. <dl class="params"><dt>Parameters</dt><dd>

  3179.   <table class="params">

  3180.     <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>

  3181.   </table>

  3182.   </dd>

  3183. </dl>

  3184. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3185. 

  3186. </div>

  3187. </div>

  3188. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  3189. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  3190. 

  3191. <div class="memitem">

  3192. <div class="memproto">

  3193. <table class="mlabels">

  3194.   <tr>

  3195.   <td class="mlabels-left">

  3196.       <table class="memname">

  3197.         <tr>

  3198.           <td class="memname">uint32_t  <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::size </td>

  3199.           <td>(</td>

  3200.           <td class="paramname"></td><td>)</td>

  3201.           <td></td>

  3202.         </tr>

  3203.       </table>

  3204.   </td>

  3205.   <td class="mlabels-right">

  3206. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3207.   </tr>

  3208. </table>

  3209. </div><div class="memdoc">

  3210. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  3211. 

  3212. </div>

  3213. </div>

  3214. <a id="a67f3dc4896c542d695e11aac927f585e"></a>

  3215. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>

  3216. 

  3217. <div class="memitem">

  3218. <div class="memproto">

  3219. <table class="mlabels">

  3220.   <tr>

  3221.   <td class="mlabels-left">

  3222.       <table class="memname">

  3223.         <tr>

  3224.           <td class="memname">bool FatFile::sync </td>

  3225.           <td>(</td>

  3226.           <td class="paramname"></td><td>)</td>

  3227.           <td></td>

  3228.         </tr>

  3229.       </table>

  3230.   </td>

  3231.   <td class="mlabels-right">

  3232. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3233.   </tr>

  3234. </table>

  3235. </div><div class="memdoc">

  3236. <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>

  3237. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3238. 

  3239. </div>

  3240. </div>

  3241. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3242. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>

  3243. 

  3244. <div class="memitem">

  3245. <div class="memproto">

  3246. <table class="mlabels">

  3247.   <tr>

  3248.   <td class="mlabels-left">

  3249.       <table class="memname">

  3250.         <tr>

  3251.           <td class="memname">bool FatFile::timestamp </td>

  3252.           <td>(</td>

  3253.           <td class="paramtype">uint8_t&#160;</td>

  3254.           <td class="paramname"><em>flags</em>, </td>

  3255.         </tr>

  3256.         <tr>

  3257.           <td class="paramkey"></td>

  3258.           <td></td>

  3259.           <td class="paramtype">uint16_t&#160;</td>

  3260.           <td class="paramname"><em>year</em>, </td>

  3261.         </tr>

  3262.         <tr>

  3263.           <td class="paramkey"></td>

  3264.           <td></td>

  3265.           <td class="paramtype">uint8_t&#160;</td>

  3266.           <td class="paramname"><em>month</em>, </td>

  3267.         </tr>

  3268.         <tr>

  3269.           <td class="paramkey"></td>

  3270.           <td></td>

  3271.           <td class="paramtype">uint8_t&#160;</td>

  3272.           <td class="paramname"><em>day</em>, </td>

  3273.         </tr>

  3274.         <tr>

  3275.           <td class="paramkey"></td>

  3276.           <td></td>

  3277.           <td class="paramtype">uint8_t&#160;</td>

  3278.           <td class="paramname"><em>hour</em>, </td>

  3279.         </tr>

  3280.         <tr>

  3281.           <td class="paramkey"></td>

  3282.           <td></td>

  3283.           <td class="paramtype">uint8_t&#160;</td>

  3284.           <td class="paramname"><em>minute</em>, </td>

  3285.         </tr>

  3286.         <tr>

  3287.           <td class="paramkey"></td>

  3288.           <td></td>

  3289.           <td class="paramtype">uint8_t&#160;</td>

  3290.           <td class="paramname"><em>second</em>&#160;</td>

  3291.         </tr>

  3292.         <tr>

  3293.           <td></td>

  3294.           <td>)</td>

  3295.           <td></td><td></td>

  3296.         </tr>

  3297.       </table>

  3298.   </td>

  3299.   <td class="mlabels-right">

  3300. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3301.   </tr>

  3302. </table>

  3303. </div><div class="memdoc">

  3304. <p>Set a file's timestamps in its directory entry.</p>

  3305. <dl class="params"><dt>Parameters</dt><dd>

  3306.   <table class="params">

  3307.     <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>

  3308.   </table>

  3309.   </dd>

  3310. </dl>

  3311. <p>T_ACCESS - Set the file's last access date.</p>

  3312. <p>T_CREATE - Set the file's creation date and time.</p>

  3313. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3314. <dl class="params"><dt>Parameters</dt><dd>

  3315.   <table class="params">

  3316.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3317.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3318.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3319.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3320.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3321.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3322.   </table>

  3323.   </dd>

  3324. </dl>

  3325. <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>

  3326. <dd>

  3327. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  3328. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3329. 

  3330. </div>

  3331. </div>

  3332. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>

  3333. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  3334. 

  3335. <div class="memitem">

  3336. <div class="memproto">

  3337. <table class="mlabels">

  3338.   <tr>

  3339.   <td class="mlabels-left">

  3340.       <table class="memname">

  3341.         <tr>

  3342.           <td class="memname">bool FatFile::truncate </td>

  3343.           <td>(</td>

  3344.           <td class="paramname"></td><td>)</td>

  3345.           <td></td>

  3346.         </tr>

  3347.       </table>

  3348.   </td>

  3349.   <td class="mlabels-right">

  3350. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3351.   </tr>

  3352. </table>

  3353. </div><div class="memdoc">

  3354. <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>

  3355. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3356. 

  3357. </div>

  3358. </div>

  3359. <a id="aa6e663098a578635d37d92e82d18d616"></a>

  3360. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  3361. 

  3362. <div class="memitem">

  3363. <div class="memproto">

  3364. <table class="mlabels">

  3365.   <tr>

  3366.   <td class="mlabels-left">

  3367.       <table class="memname">

  3368.         <tr>

  3369.           <td class="memname">bool FatFile::truncate </td>

  3370.           <td>(</td>

  3371.           <td class="paramtype">uint32_t&#160;</td>

  3372.           <td class="paramname"><em>length</em></td><td>)</td>

  3373.           <td></td>

  3374.         </tr>

  3375.       </table>

  3376.   </td>

  3377.   <td class="mlabels-right">

  3378. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3379.   </tr>

  3380. </table>

  3381. </div><div class="memdoc">

  3382. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  3383. <dl class="params"><dt>Parameters</dt><dd>

  3384.   <table class="params">

  3385.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3386.   </table>

  3387.   </dd>

  3388. </dl>

  3389. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3390. 

  3391. </div>

  3392. </div>

  3393. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>

  3394. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[1/4]</span></h2>

  3395. 

  3396. <div class="memitem">

  3397. <div class="memproto">

  3398. <table class="mlabels">

  3399.   <tr>

  3400.   <td class="mlabels-left">

  3401.       <table class="memname">

  3402.         <tr>

  3403.           <td class="memname">size_t FatFile::write </td>

  3404.           <td>(</td>

  3405.           <td class="paramtype">const char *&#160;</td>

  3406.           <td class="paramname"><em>str</em></td><td>)</td>

  3407.           <td></td>

  3408.         </tr>

  3409.       </table>

  3410.   </td>

  3411.   <td class="mlabels-right">

  3412. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3413.   </tr>

  3414. </table>

  3415. </div><div class="memdoc">

  3416. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3417.   <table class="params">

  3418.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3419.   </table>

  3420.   </dd>

  3421. </dl>

  3422. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3423. 

  3424. </div>

  3425. </div>

  3426. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  3427. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/4]</span></h2>

  3428. 

  3429. <div class="memitem">

  3430. <div class="memproto">

  3431. <table class="mlabels">

  3432.   <tr>

  3433.   <td class="mlabels-left">

  3434.       <table class="memname">

  3435.         <tr>

  3436.           <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::write </td>

  3437.           <td>(</td>

  3438.           <td class="paramtype">const uint8_t *&#160;</td>

  3439.           <td class="paramname"><em>buffer</em>, </td>

  3440.         </tr>

  3441.         <tr>

  3442.           <td class="paramkey"></td>

  3443.           <td></td>

  3444.           <td class="paramtype">size_t&#160;</td>

  3445.           <td class="paramname"><em>size</em>&#160;</td>

  3446.         </tr>

  3447.         <tr>

  3448.           <td></td>

  3449.           <td>)</td>

  3450.           <td></td><td></td>

  3451.         </tr>

  3452.       </table>

  3453.   </td>

  3454.   <td class="mlabels-right">

  3455. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3456.   </tr>

  3457. </table>

  3458. </div><div class="memdoc">

  3459. <p>Write data to an open file.</p>

  3460. <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>

  3461. <dl class="params"><dt>Parameters</dt><dd>

  3462.   <table class="params">

  3463.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  3464.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3465.   </table>

  3466.   </dd>

  3467. </dl>

  3468. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write()</a> returns the number of bytes written, always <em>size</em>. </dd></dl>

  3469. 

  3470. </div>

  3471. </div>

  3472. <a id="a5d84d871ac904a22aa48308713d14682"></a>

  3473. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[3/4]</span></h2>

  3474. 

  3475. <div class="memitem">

  3476. <div class="memproto">

  3477. <table class="mlabels">

  3478.   <tr>

  3479.   <td class="mlabels-left">

  3480.       <table class="memname">

  3481.         <tr>

  3482.           <td class="memname">size_t FatFile::write </td>

  3483.           <td>(</td>

  3484.           <td class="paramtype">const void *&#160;</td>

  3485.           <td class="paramname"><em>buf</em>, </td>

  3486.         </tr>

  3487.         <tr>

  3488.           <td class="paramkey"></td>

  3489.           <td></td>

  3490.           <td class="paramtype">size_t&#160;</td>

  3491.           <td class="paramname"><em>count</em>&#160;</td>

  3492.         </tr>

  3493.         <tr>

  3494.           <td></td>

  3495.           <td>)</td>

  3496.           <td></td><td></td>

  3497.         </tr>

  3498.       </table>

  3499.   </td>

  3500.   <td class="mlabels-right">

  3501. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3502.   </tr>

  3503. </table>

  3504. </div><div class="memdoc">

  3505. <p>Write data to an open file.</p>

  3506. <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>

  3507. <dl class="params"><dt>Parameters</dt><dd>

  3508.   <table class="params">

  3509.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3510.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  3511.   </table>

  3512.   </dd>

  3513. </dl>

  3514. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write()</a> returns the number of bytes written, always <em>count</em>. If an error occurs, <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write()</a> returns -1. Possible errors include <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">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>

  3515. 

  3516. </div>

  3517. </div>

  3518. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  3519. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[4/4]</span></h2>

  3520. 

  3521. <div class="memitem">

  3522. <div class="memproto">

  3523. <table class="mlabels">

  3524.   <tr>

  3525.   <td class="mlabels-left">

  3526.       <table class="memname">

  3527.         <tr>

  3528.           <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>&lt; <a class="el" href="class_fat_file.html">FatFile</a> , uint32_t  &gt;::write </td>

  3529.           <td>(</td>

  3530.           <td class="paramtype">uint8_t&#160;</td>

  3531.           <td class="paramname"><em>b</em></td><td>)</td>

  3532.           <td></td>

  3533.         </tr>

  3534.       </table>

  3535.   </td>

  3536.   <td class="mlabels-right">

  3537. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3538.   </tr>

  3539. </table>

  3540. </div><div class="memdoc">

  3541. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3542.   <table class="params">

  3543.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>the byte to be written. Use getWriteError to check for errors. </td></tr>

  3544.   </table>

  3545.   </dd>

  3546. </dl>

  3547. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3548. 

  3549. </div>

  3550. </div>

  3551. <hr/>The documentation for this class was generated from the following file:<ul>

  3552. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  3553. </ul>

  3554. </div><!-- contents -->

  3555. <!-- start footer part -->

  3556. <hr class="footer"/><address class="footer"><small>

  3557. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3558. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3559. </a> 1.8.16

  3560. </small></address>

  3561. </body>

  3562. </html>