visus
/
teensy-sdfat
Bevaka 1
Stjärnmärk 0
Förgrening 0
Kod Ärenden 0 Pull-förfrågningar 0 Släpp 0 Wiki Aktiviteter
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
52 Incheckningar
1 Gren
Träd: 1868633e34
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från '1868633e34'
${ noResults }
teensy-sdfat/extras/html/class_file32.html

3559 lines
157KB
Rå Blame Historik 

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

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

  3. <head>

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

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

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

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

  8. <title>SdFat: 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.14 -->

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

  67. <a href="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" id="node2" href="class_stream_file.html" title="StreamFile\&lt; FatFile,\l uint32_t \&gt;" alt="" coords="17,80,158,121"/>

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

  84. </map>

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

  86. <div class="dynheader">

  87. Collaboration diagram for File32:</div>

  88. <div class="dyncontent">

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

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

  91. <area shape="rect" id="node2" href="class_stream_file.html" title="StreamFile\&lt; FatFile,\l uint32_t \&gt;" alt="" coords="17,80,158,121"/>

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

  93. </map>

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

  95. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  276. <tr class="separator:a0ace3aaaf6d0fb673a43059c0664fab6"><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: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>

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

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

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

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

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

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

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

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

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

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

  290. </table>

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

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

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

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

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

  296. 

  297. <div class="memitem">

  298. <div class="memproto">

  299. <table class="mlabels">

  300.   <tr>

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

  302.       <table class="memname">

  303.         <tr>

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

  305.           <td>(</td>

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

  307.           <td></td>

  308.         </tr>

  309.       </table>

  310.   </td>

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

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

  313.   </tr>

  314. </table>

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

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

  317. 

  318. </div>

  319. </div>

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

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

  322. 

  323. <div class="memitem">

  324. <div class="memproto">

  325. <table class="mlabels">

  326.   <tr>

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

  328.       <table class="memname">

  329.         <tr>

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

  331.           <td>(</td>

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

  333.           <td></td>

  334.         </tr>

  335.       </table>

  336.   </td>

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

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

  339.   </tr>

  340. </table>

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

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

  343. 

  344. </div>

  345. </div>

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

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

  348. 

  349. <div class="memitem">

  350. <div class="memproto">

  351. <table class="mlabels">

  352.   <tr>

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

  354.       <table class="memname">

  355.         <tr>

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

  357.           <td>(</td>

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

  359.           <td></td>

  360.         </tr>

  361.       </table>

  362.   </td>

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

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

  365.   </tr>

  366. </table>

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

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

  369. 

  370. </div>

  371. </div>

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

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

  374. 

  375. <div class="memitem">

  376. <div class="memproto">

  377. <table class="mlabels">

  378.   <tr>

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

  380.       <table class="memname">

  381.         <tr>

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

  383.           <td>(</td>

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

  385.           <td></td>

  386.         </tr>

  387.       </table>

  388.   </td>

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

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

  391.   </tr>

  392. </table>

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

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

  395. 

  396. </div>

  397. </div>

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

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

  400. 

  401. <div class="memitem">

  402. <div class="memproto">

  403. <table class="mlabels">

  404.   <tr>

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

  406.       <table class="memname">

  407.         <tr>

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

  409.           <td>(</td>

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

  411.           <td></td>

  412.         </tr>

  413.       </table>

  414.   </td>

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

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

  417.   </tr>

  418. </table>

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

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

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

  422. 

  423. </div>

  424. </div>

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

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

  427. 

  428. <div class="memitem">

  429. <div class="memproto">

  430. <table class="mlabels">

  431.   <tr>

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

  433.       <table class="memname">

  434.         <tr>

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

  436.           <td>(</td>

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

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

  439.         </tr>

  440.         <tr>

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

  442.           <td></td>

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

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

  445.         </tr>

  446.         <tr>

  447.           <td></td>

  448.           <td>)</td>

  449.           <td></td><td></td>

  450.         </tr>

  451.       </table>

  452.   </td>

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

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

  455.   </tr>

  456. </table>

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

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

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

  460.   <table class="params">

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

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

  463.   </table>

  464.   </dd>

  465. </dl>

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

  467. 

  468. </div>

  469. </div>

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

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

  472. 

  473. <div class="memitem">

  474. <div class="memproto">

  475. <table class="mlabels">

  476.   <tr>

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

  478.       <table class="memname">

  479.         <tr>

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

  481.           <td>(</td>

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

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

  484.         </tr>

  485.         <tr>

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

  487.           <td></td>

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

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

  490.         </tr>

  491.         <tr>

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

  493.           <td></td>

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

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

  496.         </tr>

  497.         <tr>

  498.           <td></td>

  499.           <td>)</td>

  500.           <td></td><td></td>

  501.         </tr>

  502.       </table>

  503.   </td>

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

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

  506.   </tr>

  507. </table>

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

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

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

  511.   <table class="params">

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

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

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

  515.   </table>

  516.   </dd>

  517. </dl>

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

  519. 

  520. </div>

  521. </div>

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

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

  524. 

  525. <div class="memitem">

  526. <div class="memproto">

  527. <table class="mlabels">

  528.   <tr>

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

  530.       <table class="memname">

  531.         <tr>

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

  533.           <td>(</td>

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

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

  536.         </tr>

  537.         <tr>

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

  539.           <td></td>

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

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

  542.         </tr>

  543.         <tr>

  544.           <td></td>

  545.           <td>)</td>

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

  547.         </tr>

  548.       </table>

  549.   </td>

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

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

  552.   </tr>

  553. </table>

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

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

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

  557.   <table class="params">

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

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

  560.   </table>

  561.   </dd>

  562. </dl>

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

  564. 

  565. </div>

  566. </div>

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

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

  569. 

  570. <div class="memitem">

  571. <div class="memproto">

  572. <table class="mlabels">

  573.   <tr>

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

  575.       <table class="memname">

  576.         <tr>

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

  578.           <td>(</td>

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

  580.           <td> const</td>

  581.         </tr>

  582.       </table>

  583.   </td>

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

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

  586.   </tr>

  587. </table>

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

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

  590. 

  591. </div>

  592. </div>

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

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

  595. 

  596. <div class="memitem">

  597. <div class="memproto">

  598. <table class="mlabels">

  599.   <tr>

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

  601.       <table class="memname">

  602.         <tr>

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

  604.           <td>(</td>

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

  606.           <td> const</td>

  607.         </tr>

  608.       </table>

  609.   </td>

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

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

  612.   </tr>

  613. </table>

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

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

  616. 

  617. </div>

  618. </div>

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

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

  621. 

  622. <div class="memitem">

  623. <div class="memproto">

  624. <table class="mlabels">

  625.   <tr>

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

  627.       <table class="memname">

  628.         <tr>

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

  630.           <td>(</td>

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

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

  633.           <td></td>

  634.         </tr>

  635.       </table>

  636.   </td>

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

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

  639.   </tr>

  640. </table>

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

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

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

  644.   <table class="params">

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

  646.   </table>

  647.   </dd>

  648. </dl>

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

  650. 

  651. </div>

  652. </div>

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

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

  655. 

  656. <div class="memitem">

  657. <div class="memproto">

  658. <table class="mlabels">

  659.   <tr>

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

  661.       <table class="memname">

  662.         <tr>

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

  664.           <td>(</td>

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

  666.           <td></td>

  667.         </tr>

  668.       </table>

  669.   </td>

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

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

  672.   </tr>

  673. </table>

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

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

  676. 

  677. </div>

  678. </div>

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

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

  681. 

  682. <div class="memitem">

  683. <div class="memproto">

  684. <table class="mlabels">

  685.   <tr>

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

  687.       <table class="memname">

  688.         <tr>

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

  690.           <td>(</td>

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

  692.           <td></td>

  693.         </tr>

  694.       </table>

  695.   </td>

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

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

  698.   </tr>

  699. </table>

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

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

  702. 

  703. </div>

  704. </div>

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

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

  707. 

  708. <div class="memitem">

  709. <div class="memproto">

  710. <table class="mlabels">

  711.   <tr>

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

  713.       <table class="memname">

  714.         <tr>

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

  716.           <td>(</td>

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

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

  719.         </tr>

  720.         <tr>

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

  722.           <td></td>

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

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

  725.         </tr>

  726.         <tr>

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

  728.           <td></td>

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

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

  731.         </tr>

  732.         <tr>

  733.           <td></td>

  734.           <td>)</td>

  735.           <td></td><td></td>

  736.         </tr>

  737.       </table>

  738.   </td>

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

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

  741.   </tr>

  742. </table>

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

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

  745.   <table class="params">

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

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

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

  749.   </table>

  750.   </dd>

  751. </dl>

  752. 

  753. </div>

  754. </div>

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

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

  757. 

  758. <div class="memitem">

  759. <div class="memproto">

  760. <table class="mlabels">

  761.   <tr>

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

  763.       <table class="memname">

  764.         <tr>

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

  766.           <td>(</td>

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

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

  769.           <td></td>

  770.         </tr>

  771.       </table>

  772.   </td>

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

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

  775.   </tr>

  776. </table>

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

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

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

  780.   <table class="params">

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

  782.   </table>

  783.   </dd>

  784. </dl>

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

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

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

  788. 

  789. </div>

  790. </div>

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

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

  793. 

  794. <div class="memitem">

  795. <div class="memproto">

  796. <table class="mlabels">

  797.   <tr>

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

  799.       <table class="memname">

  800.         <tr>

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

  802.           <td>(</td>

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

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

  805.           <td></td>

  806.         </tr>

  807.       </table>

  808.   </td>

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

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

  811.   </tr>

  812. </table>

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

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

  815.   <table class="params">

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

  817.   </table>

  818.   </dd>

  819. </dl>

  820. 

  821. </div>

  822. </div>

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

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

  825. 

  826. <div class="memitem">

  827. <div class="memproto">

  828. <table class="mlabels">

  829.   <tr>

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

  831.       <table class="memname">

  832.         <tr>

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

  834.           <td>(</td>

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

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

  837.         </tr>

  838.         <tr>

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

  840.           <td></td>

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

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

  843.         </tr>

  844.         <tr>

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

  846.           <td></td>

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

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

  849.         </tr>

  850.         <tr>

  851.           <td></td>

  852.           <td>)</td>

  853.           <td></td><td></td>

  854.         </tr>

  855.       </table>

  856.   </td>

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

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

  859.   </tr>

  860. </table>

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

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

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

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

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

  866.   <table class="params">

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

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

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

  870.   </table>

  871.   </dd>

  872. </dl>

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

  874. 

  875. </div>

  876. </div>

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

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

  879. 

  880. <div class="memitem">

  881. <div class="memproto">

  882. <table class="mlabels">

  883.   <tr>

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

  885.       <table class="memname">

  886.         <tr>

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

  888.           <td>(</td>

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

  890.           <td> const</td>

  891.         </tr>

  892.       </table>

  893.   </td>

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

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

  896.   </tr>

  897. </table>

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

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

  900. 

  901. </div>

  902. </div>

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

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

  905. 

  906. <div class="memitem">

  907. <div class="memproto">

  908. <table class="mlabels">

  909.   <tr>

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

  911.       <table class="memname">

  912.         <tr>

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

  914.           <td>(</td>

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

  916.           <td> const</td>

  917.         </tr>

  918.       </table>

  919.   </td>

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

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

  922.   </tr>

  923. </table>

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

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

  926. 

  927. </div>

  928. </div>

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

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

  931. 

  932. <div class="memitem">

  933. <div class="memproto">

  934. <table class="mlabels">

  935.   <tr>

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

  937.       <table class="memname">

  938.         <tr>

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

  940.           <td>(</td>

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

  942.           <td> const</td>

  943.         </tr>

  944.       </table>

  945.   </td>

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

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

  948.   </tr>

  949. </table>

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

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

  952. 

  953. </div>

  954. </div>

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

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

  957. 

  958. <div class="memitem">

  959. <div class="memproto">

  960. <table class="mlabels">

  961.   <tr>

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

  963.       <table class="memname">

  964.         <tr>

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

  966.           <td>(</td>

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

  968.           <td></td>

  969.         </tr>

  970.       </table>

  971.   </td>

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

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

  974.   </tr>

  975. </table>

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

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

  978. 

  979. </div>

  980. </div>

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

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

  983. 

  984. <div class="memitem">

  985. <div class="memproto">

  986. <table class="mlabels">

  987.   <tr>

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

  989.       <table class="memname">

  990.         <tr>

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

  992.           <td>(</td>

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

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

  995.           <td></td>

  996.         </tr>

  997.       </table>

  998.   </td>

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

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

  1001.   </tr>

  1002. </table>

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

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

  1005.   <table class="params">

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

  1007.   </table>

  1008.   </dd>

  1009. </dl>

  1010. 

  1011. </div>

  1012. </div>

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

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

  1015. 

  1016. <div class="memitem">

  1017. <div class="memproto">

  1018. <table class="mlabels">

  1019.   <tr>

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

  1021.       <table class="memname">

  1022.         <tr>

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

  1024.           <td>(</td>

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

  1026.           <td></td>

  1027.         </tr>

  1028.       </table>

  1029.   </td>

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

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

  1032.   </tr>

  1033. </table>

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

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

  1036. 

  1037. </div>

  1038. </div>

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

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

  1041. 

  1042. <div class="memitem">

  1043. <div class="memproto">

  1044. <table class="mlabels">

  1045.   <tr>

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

  1047.       <table class="memname">

  1048.         <tr>

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

  1050.           <td>(</td>

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

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

  1053.         </tr>

  1054.         <tr>

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

  1056.           <td></td>

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

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

  1059.         </tr>

  1060.         <tr>

  1061.           <td></td>

  1062.           <td>)</td>

  1063.           <td></td><td></td>

  1064.         </tr>

  1065.       </table>

  1066.   </td>

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

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

  1069.   </tr>

  1070. </table>

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

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

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

  1074.   <table class="params">

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

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

  1077.   </table>

  1078.   </dd>

  1079. </dl>

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

  1081. 

  1082. </div>

  1083. </div>

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

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

  1086. 

  1087. <div class="memitem">

  1088. <div class="memproto">

  1089. <table class="mlabels">

  1090.   <tr>

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

  1092.       <table class="memname">

  1093.         <tr>

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

  1095.           <td>(</td>

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

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

  1098.           <td></td>

  1099.         </tr>

  1100.       </table>

  1101.   </td>

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

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

  1104.   </tr>

  1105. </table>

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

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

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

  1109.   <table class="params">

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

  1111.   </table>

  1112.   </dd>

  1113. </dl>

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

  1115. 

  1116. </div>

  1117. </div>

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

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

  1120. 

  1121. <div class="memitem">

  1122. <div class="memproto">

  1123. <table class="mlabels">

  1124.   <tr>

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

  1126.       <table class="memname">

  1127.         <tr>

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

  1129.           <td>(</td>

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

  1131.           <td></td>

  1132.         </tr>

  1133.       </table>

  1134.   </td>

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

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

  1137.   </tr>

  1138. </table>

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

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

  1141. 

  1142. </div>

  1143. </div>

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

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

  1146. 

  1147. <div class="memitem">

  1148. <div class="memproto">

  1149. <table class="mlabels">

  1150.   <tr>

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

  1152.       <table class="memname">

  1153.         <tr>

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

  1155.           <td>(</td>

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

  1157.           <td> const</td>

  1158.         </tr>

  1159.       </table>

  1160.   </td>

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

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

  1163.   </tr>

  1164. </table>

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

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

  1167. 

  1168. </div>

  1169. </div>

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

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

  1172. 

  1173. <div class="memitem">

  1174. <div class="memproto">

  1175. <table class="mlabels">

  1176.   <tr>

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

  1178.       <table class="memname">

  1179.         <tr>

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

  1181.           <td>(</td>

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

  1183.           <td> const</td>

  1184.         </tr>

  1185.       </table>

  1186.   </td>

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

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

  1189.   </tr>

  1190. </table>

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

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

  1193. 

  1194. </div>

  1195. </div>

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

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

  1198. 

  1199. <div class="memitem">

  1200. <div class="memproto">

  1201. <table class="mlabels">

  1202.   <tr>

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

  1204.       <table class="memname">

  1205.         <tr>

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

  1207.           <td>(</td>

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

  1209.           <td></td>

  1210.         </tr>

  1211.       </table>

  1212.   </td>

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

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

  1215.   </tr>

  1216. </table>

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

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

  1219. 

  1220. </div>

  1221. </div>

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

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

  1224. 

  1225. <div class="memitem">

  1226. <div class="memproto">

  1227. <table class="mlabels">

  1228.   <tr>

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

  1230.       <table class="memname">

  1231.         <tr>

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

  1233.           <td>(</td>

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

  1235.           <td> const</td>

  1236.         </tr>

  1237.       </table>

  1238.   </td>

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

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

  1241.   </tr>

  1242. </table>

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

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

  1245. 

  1246. </div>

  1247. </div>

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

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

  1250. 

  1251. <div class="memitem">

  1252. <div class="memproto">

  1253. <table class="mlabels">

  1254.   <tr>

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

  1256.       <table class="memname">

  1257.         <tr>

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

  1259.           <td>(</td>

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

  1261.           <td> const</td>

  1262.         </tr>

  1263.       </table>

  1264.   </td>

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

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

  1267.   </tr>

  1268. </table>

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

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

  1271. 

  1272. </div>

  1273. </div>

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

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

  1276. 

  1277. <div class="memitem">

  1278. <div class="memproto">

  1279. <table class="mlabels">

  1280.   <tr>

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

  1282.       <table class="memname">

  1283.         <tr>

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

  1285.           <td>(</td>

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

  1287.           <td> const</td>

  1288.         </tr>

  1289.       </table>

  1290.   </td>

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

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

  1293.   </tr>

  1294. </table>

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

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

  1297. 

  1298. </div>

  1299. </div>

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

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

  1302. 

  1303. <div class="memitem">

  1304. <div class="memproto">

  1305. <table class="mlabels">

  1306.   <tr>

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

  1308.       <table class="memname">

  1309.         <tr>

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

  1311.           <td>(</td>

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

  1313.           <td> const</td>

  1314.         </tr>

  1315.       </table>

  1316.   </td>

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

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

  1319.   </tr>

  1320. </table>

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

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

  1323. 

  1324. </div>

  1325. </div>

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

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

  1328. 

  1329. <div class="memitem">

  1330. <div class="memproto">

  1331. <table class="mlabels">

  1332.   <tr>

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

  1334.       <table class="memname">

  1335.         <tr>

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

  1337.           <td>(</td>

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

  1339.           <td> const</td>

  1340.         </tr>

  1341.       </table>

  1342.   </td>

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

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

  1345.   </tr>

  1346. </table>

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

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

  1349. 

  1350. </div>

  1351. </div>

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

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

  1354. 

  1355. <div class="memitem">

  1356. <div class="memproto">

  1357. <table class="mlabels">

  1358.   <tr>

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

  1360.       <table class="memname">

  1361.         <tr>

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

  1363.           <td>(</td>

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

  1365.           <td> const</td>

  1366.         </tr>

  1367.       </table>

  1368.   </td>

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

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

  1371.   </tr>

  1372. </table>

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

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

  1375. 

  1376. </div>

  1377. </div>

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

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

  1380. 

  1381. <div class="memitem">

  1382. <div class="memproto">

  1383. <table class="mlabels">

  1384.   <tr>

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

  1386.       <table class="memname">

  1387.         <tr>

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

  1389.           <td>(</td>

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

  1391.           <td> const</td>

  1392.         </tr>

  1393.       </table>

  1394.   </td>

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

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

  1397.   </tr>

  1398. </table>

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

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

  1401. 

  1402. </div>

  1403. </div>

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

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

  1406. 

  1407. <div class="memitem">

  1408. <div class="memproto">

  1409. <table class="mlabels">

  1410.   <tr>

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

  1412.       <table class="memname">

  1413.         <tr>

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

  1415.           <td>(</td>

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

  1417.           <td> const</td>

  1418.         </tr>

  1419.       </table>

  1420.   </td>

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

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

  1423.   </tr>

  1424. </table>

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

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

  1427. 

  1428. </div>

  1429. </div>

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

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

  1432. 

  1433. <div class="memitem">

  1434. <div class="memproto">

  1435. <table class="mlabels">

  1436.   <tr>

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

  1438.       <table class="memname">

  1439.         <tr>

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

  1441.           <td>(</td>

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

  1443.           <td> const</td>

  1444.         </tr>

  1445.       </table>

  1446.   </td>

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

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

  1449.   </tr>

  1450. </table>

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

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

  1453. 

  1454. </div>

  1455. </div>

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

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

  1458. 

  1459. <div class="memitem">

  1460. <div class="memproto">

  1461. <table class="mlabels">

  1462.   <tr>

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

  1464.       <table class="memname">

  1465.         <tr>

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

  1467.           <td>(</td>

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

  1469.           <td> const</td>

  1470.         </tr>

  1471.       </table>

  1472.   </td>

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

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

  1475.   </tr>

  1476. </table>

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

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

  1479. 

  1480. </div>

  1481. </div>

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

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

  1484. 

  1485. <div class="memitem">

  1486. <div class="memproto">

  1487. <table class="mlabels">

  1488.   <tr>

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

  1490.       <table class="memname">

  1491.         <tr>

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

  1493.           <td>(</td>

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

  1495.           <td> const</td>

  1496.         </tr>

  1497.       </table>

  1498.   </td>

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

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

  1501.   </tr>

  1502. </table>

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

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

  1505. 

  1506. </div>

  1507. </div>

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

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

  1510. 

  1511. <div class="memitem">

  1512. <div class="memproto">

  1513. <table class="mlabels">

  1514.   <tr>

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

  1516.       <table class="memname">

  1517.         <tr>

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

  1519.           <td>(</td>

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

  1521.           <td> const</td>

  1522.         </tr>

  1523.       </table>

  1524.   </td>

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

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

  1527.   </tr>

  1528. </table>

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

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

  1531. 

  1532. </div>

  1533. </div>

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

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

  1536. 

  1537. <div class="memitem">

  1538. <div class="memproto">

  1539. <table class="mlabels">

  1540.   <tr>

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

  1542.       <table class="memname">

  1543.         <tr>

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

  1545.           <td>(</td>

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

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

  1548.           <td></td>

  1549.         </tr>

  1550.       </table>

  1551.   </td>

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

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

  1554.   </tr>

  1555. </table>

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

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

  1558.   <table class="params">

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

  1560.   </table>

  1561.   </dd>

  1562. </dl>

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

  1564. 

  1565. </div>

  1566. </div>

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

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

  1569. 

  1570. <div class="memitem">

  1571. <div class="memproto">

  1572. <table class="mlabels">

  1573.   <tr>

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

  1575.       <table class="memname">

  1576.         <tr>

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

  1578.           <td>(</td>

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

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

  1581.         </tr>

  1582.         <tr>

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

  1584.           <td></td>

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

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

  1587.         </tr>

  1588.         <tr>

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

  1590.           <td></td>

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

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

  1593.         </tr>

  1594.         <tr>

  1595.           <td></td>

  1596.           <td>)</td>

  1597.           <td></td><td></td>

  1598.         </tr>

  1599.       </table>

  1600.   </td>

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

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

  1603.   </tr>

  1604. </table>

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

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

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

  1608.   <table class="params">

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

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

  1611.   </table>

  1612.   </dd>

  1613. </dl>

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

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

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

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

  1618.   <table class="params">

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

  1620.   </table>

  1621.   </dd>

  1622. </dl>

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

  1624. 

  1625. </div>

  1626. </div>

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

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

  1629. 

  1630. <div class="memitem">

  1631. <div class="memproto">

  1632. <table class="mlabels">

  1633.   <tr>

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

  1635.       <table class="memname">

  1636.         <tr>

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

  1638.           <td>(</td>

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

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

  1641.           <td></td>

  1642.         </tr>

  1643.       </table>

  1644.   </td>

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

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

  1647.   </tr>

  1648. </table>

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

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

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

  1652.   <table class="params">

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

  1654.   </table>

  1655.   </dd>

  1656. </dl>

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

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

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

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

  1661. 

  1662. </div>

  1663. </div>

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

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

  1666. 

  1667. <div class="memitem">

  1668. <div class="memproto">

  1669. <table class="mlabels">

  1670.   <tr>

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

  1672.       <table class="memname">

  1673.         <tr>

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

  1675.           <td>(</td>

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

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

  1678.         </tr>

  1679.         <tr>

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

  1681.           <td></td>

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

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

  1684.         </tr>

  1685.         <tr>

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

  1687.           <td></td>

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

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

  1690.         </tr>

  1691.         <tr>

  1692.           <td></td>

  1693.           <td>)</td>

  1694.           <td></td><td></td>

  1695.         </tr>

  1696.       </table>

  1697.   </td>

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

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

  1700.   </tr>

  1701. </table>

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

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

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

  1705.   <table class="params">

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

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

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

  1709.   </table>

  1710.   </dd>

  1711. </dl>

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

  1713. 

  1714. </div>

  1715. </div>

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

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

  1718. 

  1719. <div class="memitem">

  1720. <div class="memproto">

  1721. <table class="mlabels">

  1722.   <tr>

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

  1724.       <table class="memname">

  1725.         <tr>

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

  1727.           <td>(</td>

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

  1729.           <td> const</td>

  1730.         </tr>

  1731.       </table>

  1732.   </td>

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

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

  1735.   </tr>

  1736. </table>

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

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

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

  1740. 

  1741. </div>

  1742. </div>

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

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

  1745. 

  1746. <div class="memitem">

  1747. <div class="memproto">

  1748. <table class="mlabels">

  1749.   <tr>

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

  1751.       <table class="memname">

  1752.         <tr>

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

  1754.           <td>(</td>

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

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

  1757.         </tr>

  1758.         <tr>

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

  1760.           <td></td>

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

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

  1763.         </tr>

  1764.         <tr>

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

  1766.           <td></td>

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

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

  1769.         </tr>

  1770.         <tr>

  1771.           <td></td>

  1772.           <td>)</td>

  1773.           <td></td><td></td>

  1774.         </tr>

  1775.       </table>

  1776.   </td>

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

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

  1779.   </tr>

  1780. </table>

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

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

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

  1784.   <table class="params">

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

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

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

  1788.   </table>

  1789.   </dd>

  1790. </dl>

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

  1792. 

  1793. </div>

  1794. </div>

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

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

  1797. 

  1798. <div class="memitem">

  1799. <div class="memproto">

  1800. <table class="mlabels">

  1801.   <tr>

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

  1803.       <table class="memname">

  1804.         <tr>

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

  1806.           <td>(</td>

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

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

  1809.         </tr>

  1810.         <tr>

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

  1812.           <td></td>

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

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

  1815.         </tr>

  1816.         <tr>

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

  1818.           <td></td>

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

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

  1821.         </tr>

  1822.         <tr>

  1823.           <td></td>

  1824.           <td>)</td>

  1825.           <td></td><td></td>

  1826.         </tr>

  1827.       </table>

  1828.   </td>

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

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

  1831.   </tr>

  1832. </table>

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

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

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

  1836.   <table class="params">

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

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

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

  1840.   </table>

  1841.   </dd>

  1842. </dl>

  1843. <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>

  1844. 

  1845. </div>

  1846. </div>

  1847. <a id="a58d6ea245f1bc3ae7a6df311cd25052f"></a>

  1848. <h2 class="memtitle"><span class="permalink"><a href="#a58d6ea245f1bc3ae7a6df311cd25052f">&#9670;&nbsp;</a></span>open() <span class="overload">[3/4]</span></h2>

  1849. 

  1850. <div class="memitem">

  1851. <div class="memproto">

  1852. <table class="mlabels">

  1853.   <tr>

  1854.   <td class="mlabels-left">

  1855.       <table class="memname">

  1856.         <tr>

  1857.           <td class="memname">bool FatFile::open </td>

  1858.           <td>(</td>

  1859.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1860.           <td class="paramname"><em>dirFile</em>, </td>

  1861.         </tr>

  1862.         <tr>

  1863.           <td class="paramkey"></td>

  1864.           <td></td>

  1865.           <td class="paramtype">const char *&#160;</td>

  1866.           <td class="paramname"><em>path</em>, </td>

  1867.         </tr>

  1868.         <tr>

  1869.           <td class="paramkey"></td>

  1870.           <td></td>

  1871.           <td class="paramtype">oflag_t&#160;</td>

  1872.           <td class="paramname"><em>oflag</em>&#160;</td>

  1873.         </tr>

  1874.         <tr>

  1875.           <td></td>

  1876.           <td>)</td>

  1877.           <td></td><td></td>

  1878.         </tr>

  1879.       </table>

  1880.   </td>

  1881.   <td class="mlabels-right">

  1882. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1883.   </tr>

  1884. </table>

  1885. </div><div class="memdoc">

  1886. <p>Open a file or directory by name.</p>

  1887. <dl class="params"><dt>Parameters</dt><dd>

  1888.   <table class="params">

  1889.     <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>

  1890.     <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>

  1891.     <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>

  1892.   </table>

  1893.   </dd>

  1894. </dl>

  1895. <p>O_RDONLY - Open for reading.</p>

  1896. <p>O_READ - Same as O_RDONLY.</p>

  1897. <p>O_WRONLY - Open for writing.</p>

  1898. <p>O_WRITE - Same as O_WRONLY.</p>

  1899. <p>O_RDWR - Open for reading and writing.</p>

  1900. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>

  1901. <p>O_AT_END - Set the initial position at the end of the file.</p>

  1902. <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>

  1903. <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>

  1904. <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>

  1905. <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>

  1906. <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>

  1907. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1908. 

  1909. </div>

  1910. </div>

  1911. <a id="afd3e4d5a76b6751ca796fc57f4dd2be4"></a>

  1912. <h2 class="memtitle"><span class="permalink"><a href="#afd3e4d5a76b6751ca796fc57f4dd2be4">&#9670;&nbsp;</a></span>open() <span class="overload">[4/4]</span></h2>

  1913. 

  1914. <div class="memitem">

  1915. <div class="memproto">

  1916. <table class="mlabels">

  1917.   <tr>

  1918.   <td class="mlabels-left">

  1919.       <table class="memname">

  1920.         <tr>

  1921.           <td class="memname">bool FatFile::open </td>

  1922.           <td>(</td>

  1923.           <td class="paramtype">const char *&#160;</td>

  1924.           <td class="paramname"><em>path</em>, </td>

  1925.         </tr>

  1926.         <tr>

  1927.           <td class="paramkey"></td>

  1928.           <td></td>

  1929.           <td class="paramtype">oflag_t&#160;</td>

  1930.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1931.         </tr>

  1932.         <tr>

  1933.           <td></td>

  1934.           <td>)</td>

  1935.           <td></td><td></td>

  1936.         </tr>

  1937.       </table>

  1938.   </td>

  1939.   <td class="mlabels-right">

  1940. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1941.   </tr>

  1942. </table>

  1943. </div><div class="memdoc">

  1944. <p>Open a file in the current working volume.</p>

  1945. <dl class="params"><dt>Parameters</dt><dd>

  1946.   <table class="params">

  1947.     <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>

  1948.     <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>

  1949.   </table>

  1950.   </dd>

  1951. </dl>

  1952. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1953. 

  1954. </div>

  1955. </div>

  1956. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>

  1957. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>

  1958. 

  1959. <div class="memitem">

  1960. <div class="memproto">

  1961. <table class="mlabels">

  1962.   <tr>

  1963.   <td class="mlabels-left">

  1964.       <table class="memname">

  1965.         <tr>

  1966.           <td class="memname">bool FatFile::openNext </td>

  1967.           <td>(</td>

  1968.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1969.           <td class="paramname"><em>dirFile</em>, </td>

  1970.         </tr>

  1971.         <tr>

  1972.           <td class="paramkey"></td>

  1973.           <td></td>

  1974.           <td class="paramtype">oflag_t&#160;</td>

  1975.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1976.         </tr>

  1977.         <tr>

  1978.           <td></td>

  1979.           <td>)</td>

  1980.           <td></td><td></td>

  1981.         </tr>

  1982.       </table>

  1983.   </td>

  1984.   <td class="mlabels-right">

  1985. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1986.   </tr>

  1987. </table>

  1988. </div><div class="memdoc">

  1989. <p>Open the next file or subdirectory in a directory.</p>

  1990. <dl class="params"><dt>Parameters</dt><dd>

  1991.   <table class="params">

  1992.     <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>

  1993.     <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>

  1994.   </table>

  1995.   </dd>

  1996. </dl>

  1997. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1998. 

  1999. </div>

  2000. </div>

  2001. <a id="a571434707124ee554d659ec82e2ef750"></a>

  2002. <h2 class="memtitle"><span class="permalink"><a href="#a571434707124ee554d659ec82e2ef750">&#9670;&nbsp;</a></span>openNextFile()</h2>

  2003. 

  2004. <div class="memitem">

  2005. <div class="memproto">

  2006. <table class="mlabels">

  2007.   <tr>

  2008.   <td class="mlabels-left">

  2009.       <table class="memname">

  2010.         <tr>

  2011.           <td class="memname"><a class="el" href="class_file32.html">File32</a> File32::openNextFile </td>

  2012.           <td>(</td>

  2013.           <td class="paramtype">oflag_t&#160;</td>

  2014.           <td class="paramname"><em>oflag</em> = <code>0X00</code></td><td>)</td>

  2015.           <td></td>

  2016.         </tr>

  2017.       </table>

  2018.   </td>

  2019.   <td class="mlabels-right">

  2020. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2021.   </tr>

  2022. </table>

  2023. </div><div class="memdoc">

  2024. <p>Opens the next file or folder in a directory.</p>

  2025. <dl class="params"><dt>Parameters</dt><dd>

  2026.   <table class="params">

  2027.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>

  2028.   </table>

  2029.   </dd>

  2030. </dl>

  2031. <dl class="section return"><dt>Returns</dt><dd>a FatStream object. </dd></dl>

  2032. 

  2033. </div>

  2034. </div>

  2035. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  2036. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>

  2037. 

  2038. <div class="memitem">

  2039. <div class="memproto">

  2040. <table class="mlabels">

  2041.   <tr>

  2042.   <td class="mlabels-left">

  2043.       <table class="memname">

  2044.         <tr>

  2045.           <td class="memname">bool FatFile::openRoot </td>

  2046.           <td>(</td>

  2047.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  2048.           <td class="paramname"><em>vol</em></td><td>)</td>

  2049.           <td></td>

  2050.         </tr>

  2051.       </table>

  2052.   </td>

  2053.   <td class="mlabels-right">

  2054. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2055.   </tr>

  2056. </table>

  2057. </div><div class="memdoc">

  2058. <p>Open a volume's root directory.</p>

  2059. <dl class="params"><dt>Parameters</dt><dd>

  2060.   <table class="params">

  2061.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  2062.   </table>

  2063.   </dd>

  2064. </dl>

  2065. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2066. 

  2067. </div>

  2068. </div>

  2069. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>

  2070. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>

  2071. 

  2072. <div class="memitem">

  2073. <div class="memproto">

  2074. <table class="mlabels">

  2075.   <tr>

  2076.   <td class="mlabels-left">

  2077.       <table class="memname">

  2078.         <tr>

  2079.           <td class="memname">FatFile::operator bool </td>

  2080.           <td>(</td>

  2081.           <td class="paramname"></td><td>)</td>

  2082.           <td></td>

  2083.         </tr>

  2084.       </table>

  2085.   </td>

  2086.   <td class="mlabels-right">

  2087. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2088.   </tr>

  2089. </table>

  2090. </div><div class="memdoc">

  2091. <p>The parenthesis operator.</p>

  2092. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  2093. 

  2094. </div>

  2095. </div>

  2096. <a id="af0da96e502485133ca0cff27fa130082"></a>

  2097. <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">&#9670;&nbsp;</a></span>peek()</h2>

  2098. 

  2099. <div class="memitem">

  2100. <div class="memproto">

  2101. <table class="mlabels">

  2102.   <tr>

  2103.   <td class="mlabels-left">

  2104.       <table class="memname">

  2105.         <tr>

  2106.           <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>

  2107.           <td>(</td>

  2108.           <td class="paramname"></td><td>)</td>

  2109.           <td></td>

  2110.         </tr>

  2111.       </table>

  2112.   </td>

  2113.   <td class="mlabels-right">

  2114. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2115.   </tr>

  2116. </table>

  2117. </div><div class="memdoc">

  2118. <p>Return the next available byte without consuming it.</p>

  2119. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  2120. 

  2121. </div>

  2122. </div>

  2123. <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>

  2124. <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">&#9670;&nbsp;</a></span>position()</h2>

  2125. 

  2126. <div class="memitem">

  2127. <div class="memproto">

  2128. <table class="mlabels">

  2129.   <tr>

  2130.   <td class="mlabels-left">

  2131.       <table class="memname">

  2132.         <tr>

  2133.           <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>

  2134.           <td>(</td>

  2135.           <td class="paramname"></td><td>)</td>

  2136.           <td></td>

  2137.         </tr>

  2138.       </table>

  2139.   </td>

  2140.   <td class="mlabels-right">

  2141. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2142.   </tr>

  2143. </table>

  2144. </div><div class="memdoc">

  2145. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  2146. 

  2147. </div>

  2148. </div>

  2149. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>

  2150. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>

  2151. 

  2152. <div class="memitem">

  2153. <div class="memproto">

  2154. <table class="mlabels">

  2155.   <tr>

  2156.   <td class="mlabels-left">

  2157.       <table class="memname">

  2158.         <tr>

  2159.           <td class="memname">bool FatFile::preAllocate </td>

  2160.           <td>(</td>

  2161.           <td class="paramtype">uint32_t&#160;</td>

  2162.           <td class="paramname"><em>length</em></td><td>)</td>

  2163.           <td></td>

  2164.         </tr>

  2165.       </table>

  2166.   </td>

  2167.   <td class="mlabels-right">

  2168. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2169.   </tr>

  2170. </table>

  2171. </div><div class="memdoc">

  2172. <p>Allocate contiguous clusters to an empty file.</p>

  2173. <p>The file must be empty with no clusters allocated.</p>

  2174. <p>The file will contain uninitialized data.</p>

  2175. <dl class="params"><dt>Parameters</dt><dd>

  2176.   <table class="params">

  2177.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  2178.   </table>

  2179.   </dd>

  2180. </dl>

  2181. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2182. 

  2183. </div>

  2184. </div>

  2185. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>

  2186. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>

  2187. 

  2188. <div class="memitem">

  2189. <div class="memproto">

  2190. <table class="mlabels">

  2191.   <tr>

  2192.   <td class="mlabels-left">

  2193.       <table class="memname">

  2194.         <tr>

  2195.           <td class="memname">size_t FatFile::printAccessDate </td>

  2196.           <td>(</td>

  2197.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2198.           <td class="paramname"><em>pr</em></td><td>)</td>

  2199.           <td></td>

  2200.         </tr>

  2201.       </table>

  2202.   </td>

  2203.   <td class="mlabels-right">

  2204. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2205.   </tr>

  2206. </table>

  2207. </div><div class="memdoc">

  2208. <p>Print a file's access date</p>

  2209. <dl class="params"><dt>Parameters</dt><dd>

  2210.   <table class="params">

  2211.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2212.   </table>

  2213.   </dd>

  2214. </dl>

  2215. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2216. 

  2217. </div>

  2218. </div>

  2219. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>

  2220. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>

  2221. 

  2222. <div class="memitem">

  2223. <div class="memproto">

  2224. <table class="mlabels">

  2225.   <tr>

  2226.   <td class="mlabels-left">

  2227.       <table class="memname">

  2228.         <tr>

  2229.           <td class="memname">size_t FatFile::printAccessDateTime </td>

  2230.           <td>(</td>

  2231.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2232.           <td class="paramname"><em>pr</em></td><td>)</td>

  2233.           <td></td>

  2234.         </tr>

  2235.       </table>

  2236.   </td>

  2237.   <td class="mlabels-right">

  2238. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2239.   </tr>

  2240. </table>

  2241. </div><div class="memdoc">

  2242. <p>Print a file's access date</p>

  2243. <dl class="params"><dt>Parameters</dt><dd>

  2244.   <table class="params">

  2245.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2246.   </table>

  2247.   </dd>

  2248. </dl>

  2249. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2250. 

  2251. </div>

  2252. </div>

  2253. <a id="ab22396a285e27b53501a0047ddd97f59"></a>

  2254. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  2255. 

  2256. <div class="memitem">

  2257. <div class="memproto">

  2258. <table class="mlabels">

  2259.   <tr>

  2260.   <td class="mlabels-left">

  2261.       <table class="memname">

  2262.         <tr>

  2263.           <td class="memname">size_t FatFile::printCreateDateTime </td>

  2264.           <td>(</td>

  2265.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2266.           <td class="paramname"><em>pr</em></td><td>)</td>

  2267.           <td></td>

  2268.         </tr>

  2269.       </table>

  2270.   </td>

  2271.   <td class="mlabels-right">

  2272. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2273.   </tr>

  2274. </table>

  2275. </div><div class="memdoc">

  2276. <p>Print a file's creation date and time</p>

  2277. <dl class="params"><dt>Parameters</dt><dd>

  2278.   <table class="params">

  2279.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2280.   </table>

  2281.   </dd>

  2282. </dl>

  2283. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  2284. 

  2285. </div>

  2286. </div>

  2287. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>

  2288. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>

  2289. 

  2290. <div class="memitem">

  2291. <div class="memproto">

  2292. <table class="mlabels">

  2293.   <tr>

  2294.   <td class="mlabels-left">

  2295.       <table class="memname">

  2296.         <tr>

  2297.           <td class="memname">static void FatFile::printFatDate </td>

  2298.           <td>(</td>

  2299.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2300.           <td class="paramname"><em>pr</em>, </td>

  2301.         </tr>

  2302.         <tr>

  2303.           <td class="paramkey"></td>

  2304.           <td></td>

  2305.           <td class="paramtype">uint16_t&#160;</td>

  2306.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2307.         </tr>

  2308.         <tr>

  2309.           <td></td>

  2310.           <td>)</td>

  2311.           <td></td><td></td>

  2312.         </tr>

  2313.       </table>

  2314.   </td>

  2315.   <td class="mlabels-right">

  2316. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2317.   </tr>

  2318. </table>

  2319. </div><div class="memdoc">

  2320. <p>Print a directory date field.</p>

  2321. <p>Format is yyyy-mm-dd.</p>

  2322. <dl class="params"><dt>Parameters</dt><dd>

  2323.   <table class="params">

  2324.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2325.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2326.   </table>

  2327.   </dd>

  2328. </dl>

  2329. 

  2330. </div>

  2331. </div>

  2332. <a id="a7f84d953190ea94710dad9ebb897b957"></a>

  2333. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>

  2334. 

  2335. <div class="memitem">

  2336. <div class="memproto">

  2337. <table class="mlabels">

  2338.   <tr>

  2339.   <td class="mlabels-left">

  2340.       <table class="memname">

  2341.         <tr>

  2342.           <td class="memname">static void FatFile::printFatTime </td>

  2343.           <td>(</td>

  2344.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2345.           <td class="paramname"><em>pr</em>, </td>

  2346.         </tr>

  2347.         <tr>

  2348.           <td class="paramkey"></td>

  2349.           <td></td>

  2350.           <td class="paramtype">uint16_t&#160;</td>

  2351.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2352.         </tr>

  2353.         <tr>

  2354.           <td></td>

  2355.           <td>)</td>

  2356.           <td></td><td></td>

  2357.         </tr>

  2358.       </table>

  2359.   </td>

  2360.   <td class="mlabels-right">

  2361. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2362.   </tr>

  2363. </table>

  2364. </div><div class="memdoc">

  2365. <p>Print a directory time field.</p>

  2366. <p>Format is hh:mm:ss.</p>

  2367. <dl class="params"><dt>Parameters</dt><dd>

  2368.   <table class="params">

  2369.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2370.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2371.   </table>

  2372.   </dd>

  2373. </dl>

  2374. 

  2375. </div>

  2376. </div>

  2377. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>

  2378. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  2379. 

  2380. <div class="memitem">

  2381. <div class="memproto">

  2382. <table class="mlabels">

  2383.   <tr>

  2384.   <td class="mlabels-left">

  2385.       <table class="memname">

  2386.         <tr>

  2387.           <td class="memname">size_t FatFile::printField </td>

  2388.           <td>(</td>

  2389.           <td class="paramtype">double&#160;</td>

  2390.           <td class="paramname"><em>value</em>, </td>

  2391.         </tr>

  2392.         <tr>

  2393.           <td class="paramkey"></td>

  2394.           <td></td>

  2395.           <td class="paramtype">char&#160;</td>

  2396.           <td class="paramname"><em>term</em>, </td>

  2397.         </tr>

  2398.         <tr>

  2399.           <td class="paramkey"></td>

  2400.           <td></td>

  2401.           <td class="paramtype">uint8_t&#160;</td>

  2402.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2403.         </tr>

  2404.         <tr>

  2405.           <td></td>

  2406.           <td>)</td>

  2407.           <td></td><td></td>

  2408.         </tr>

  2409.       </table>

  2410.   </td>

  2411.   <td class="mlabels-right">

  2412. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2413.   </tr>

  2414. </table>

  2415. </div><div class="memdoc">

  2416. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2417.   <table class="params">

  2418.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2419.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2420.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2421.   </table>

  2422.   </dd>

  2423. </dl>

  2424. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2425. 

  2426. </div>

  2427. </div>

  2428. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>

  2429. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  2430. 

  2431. <div class="memitem">

  2432. <div class="memproto">

  2433. <table class="mlabels">

  2434.   <tr>

  2435.   <td class="mlabels-left">

  2436.       <table class="memname">

  2437.         <tr>

  2438.           <td class="memname">size_t FatFile::printField </td>

  2439.           <td>(</td>

  2440.           <td class="paramtype">float&#160;</td>

  2441.           <td class="paramname"><em>value</em>, </td>

  2442.         </tr>

  2443.         <tr>

  2444.           <td class="paramkey"></td>

  2445.           <td></td>

  2446.           <td class="paramtype">char&#160;</td>

  2447.           <td class="paramname"><em>term</em>, </td>

  2448.         </tr>

  2449.         <tr>

  2450.           <td class="paramkey"></td>

  2451.           <td></td>

  2452.           <td class="paramtype">uint8_t&#160;</td>

  2453.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2454.         </tr>

  2455.         <tr>

  2456.           <td></td>

  2457.           <td>)</td>

  2458.           <td></td><td></td>

  2459.         </tr>

  2460.       </table>

  2461.   </td>

  2462.   <td class="mlabels-right">

  2463. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2464.   </tr>

  2465. </table>

  2466. </div><div class="memdoc">

  2467. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2468.   <table class="params">

  2469.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2470.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2471.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2472.   </table>

  2473.   </dd>

  2474. </dl>

  2475. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2476. 

  2477. </div>

  2478. </div>

  2479. <a id="a8f906be79086f38943cb0911310d67bf"></a>

  2480. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  2481. 

  2482. <div class="memitem">

  2483. <div class="memproto">

  2484. <div class="memtemplate">

  2485. template&lt;typename Type &gt; </div>

  2486. <table class="mlabels">

  2487.   <tr>

  2488.   <td class="mlabels-left">

  2489.       <table class="memname">

  2490.         <tr>

  2491.           <td class="memname">size_t FatFile::printField </td>

  2492.           <td>(</td>

  2493.           <td class="paramtype">Type&#160;</td>

  2494.           <td class="paramname"><em>value</em>, </td>

  2495.         </tr>

  2496.         <tr>

  2497.           <td class="paramkey"></td>

  2498.           <td></td>

  2499.           <td class="paramtype">char&#160;</td>

  2500.           <td class="paramname"><em>term</em>&#160;</td>

  2501.         </tr>

  2502.         <tr>

  2503.           <td></td>

  2504.           <td>)</td>

  2505.           <td></td><td></td>

  2506.         </tr>

  2507.       </table>

  2508.   </td>

  2509.   <td class="mlabels-right">

  2510. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2511.   </tr>

  2512. </table>

  2513. </div><div class="memdoc">

  2514. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2515.   <table class="params">

  2516.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2517.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2518.   </table>

  2519.   </dd>

  2520. </dl>

  2521. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2522. 

  2523. </div>

  2524. </div>

  2525. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2526. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>

  2527. 

  2528. <div class="memitem">

  2529. <div class="memproto">

  2530. <table class="mlabels">

  2531.   <tr>

  2532.   <td class="mlabels-left">

  2533.       <table class="memname">

  2534.         <tr>

  2535.           <td class="memname">size_t FatFile::printFileSize </td>

  2536.           <td>(</td>

  2537.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2538.           <td class="paramname"><em>pr</em></td><td>)</td>

  2539.           <td></td>

  2540.         </tr>

  2541.       </table>

  2542.   </td>

  2543.   <td class="mlabels-right">

  2544. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2545.   </tr>

  2546. </table>

  2547. </div><div class="memdoc">

  2548. <p>Print a file's size.</p>

  2549. <dl class="params"><dt>Parameters</dt><dd>

  2550.   <table class="params">

  2551.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2552.   </table>

  2553.   </dd>

  2554. </dl>

  2555. <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>

  2556. 

  2557. </div>

  2558. </div>

  2559. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>

  2560. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>

  2561. 

  2562. <div class="memitem">

  2563. <div class="memproto">

  2564. <table class="mlabels">

  2565.   <tr>

  2566.   <td class="mlabels-left">

  2567.       <table class="memname">

  2568.         <tr>

  2569.           <td class="memname">size_t FatFile::printModifyDateTime </td>

  2570.           <td>(</td>

  2571.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2572.           <td class="paramname"><em>pr</em></td><td>)</td>

  2573.           <td></td>

  2574.         </tr>

  2575.       </table>

  2576.   </td>

  2577.   <td class="mlabels-right">

  2578. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2579.   </tr>

  2580. </table>

  2581. </div><div class="memdoc">

  2582. <p>Print a file's modify date and time</p>

  2583. <dl class="params"><dt>Parameters</dt><dd>

  2584.   <table class="params">

  2585.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2586.   </table>

  2587.   </dd>

  2588. </dl>

  2589. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2590. 

  2591. </div>

  2592. </div>

  2593. <a id="afe18a787fb8640e2d2483370c770f82f"></a>

  2594. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName() <span class="overload">[1/2]</span></h2>

  2595. 

  2596. <div class="memitem">

  2597. <div class="memproto">

  2598. <table class="mlabels">

  2599.   <tr>

  2600.   <td class="mlabels-left">

  2601.       <table class="memname">

  2602.         <tr>

  2603.           <td class="memname">size_t FatFile::printName </td>

  2604.           <td>(</td>

  2605.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2606.           <td class="paramname"><em>pr</em></td><td>)</td>

  2607.           <td></td>

  2608.         </tr>

  2609.       </table>

  2610.   </td>

  2611.   <td class="mlabels-right">

  2612. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2613.   </tr>

  2614. </table>

  2615. </div><div class="memdoc">

  2616. <p>Print a file's name</p>

  2617. <dl class="params"><dt>Parameters</dt><dd>

  2618.   <table class="params">

  2619.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2620.   </table>

  2621.   </dd>

  2622. </dl>

  2623. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2624. 

  2625. </div>

  2626. </div>

  2627. <a id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2628. <h2 class="memtitle"><span class="permalink"><a href="#ad1cbc3aeb0f5193b7a26595966da9621">&#9670;&nbsp;</a></span>printName() <span class="overload">[2/2]</span></h2>

  2629. 

  2630. <div class="memitem">

  2631. <div class="memproto">

  2632. <table class="mlabels">

  2633.   <tr>

  2634.   <td class="mlabels-left">

  2635.       <table class="memname">

  2636.         <tr>

  2637.           <td class="memname">size_t FatFile::printName </td>

  2638.           <td>(</td>

  2639.           <td class="paramname"></td><td>)</td>

  2640.           <td></td>

  2641.         </tr>

  2642.       </table>

  2643.   </td>

  2644.   <td class="mlabels-right">

  2645. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2646.   </tr>

  2647. </table>

  2648. </div><div class="memdoc">

  2649. <p>Print a file's name.</p>

  2650. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2651. 

  2652. </div>

  2653. </div>

  2654. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2655. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>

  2656. 

  2657. <div class="memitem">

  2658. <div class="memproto">

  2659. <table class="mlabels">

  2660.   <tr>

  2661.   <td class="mlabels-left">

  2662.       <table class="memname">

  2663.         <tr>

  2664.           <td class="memname">size_t FatFile::printSFN </td>

  2665.           <td>(</td>

  2666.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2667.           <td class="paramname"><em>pr</em></td><td>)</td>

  2668.           <td></td>

  2669.         </tr>

  2670.       </table>

  2671.   </td>

  2672.   <td class="mlabels-right">

  2673. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2674.   </tr>

  2675. </table>

  2676. </div><div class="memdoc">

  2677. <p>Print a file's Short File Name.</p>

  2678. <dl class="params"><dt>Parameters</dt><dd>

  2679.   <table class="params">

  2680.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2681.   </table>

  2682.   </dd>

  2683. </dl>

  2684. <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>

  2685. 

  2686. </div>

  2687. </div>

  2688. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>

  2689. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  2690. 

  2691. <div class="memitem">

  2692. <div class="memproto">

  2693. <table class="mlabels">

  2694.   <tr>

  2695.   <td class="mlabels-left">

  2696.       <table class="memname">

  2697.         <tr>

  2698.           <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>

  2699.           <td>(</td>

  2700.           <td class="paramname"></td><td>)</td>

  2701.           <td></td>

  2702.         </tr>

  2703.       </table>

  2704.   </td>

  2705.   <td class="mlabels-right">

  2706. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2707.   </tr>

  2708. </table>

  2709. </div><div class="memdoc">

  2710. <p>Read the next byte from a file.</p>

  2711. <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>

  2712. 

  2713. </div>

  2714. </div>

  2715. <a id="aba893af8107a18017482d2311b066187"></a>

  2716. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2717. 

  2718. <div class="memitem">

  2719. <div class="memproto">

  2720. <table class="mlabels">

  2721.   <tr>

  2722.   <td class="mlabels-left">

  2723.       <table class="memname">

  2724.         <tr>

  2725.           <td class="memname">int FatFile::read </td>

  2726.           <td>(</td>

  2727.           <td class="paramtype">void *&#160;</td>

  2728.           <td class="paramname"><em>buf</em>, </td>

  2729.         </tr>

  2730.         <tr>

  2731.           <td class="paramkey"></td>

  2732.           <td></td>

  2733.           <td class="paramtype">size_t&#160;</td>

  2734.           <td class="paramname"><em>count</em>&#160;</td>

  2735.         </tr>

  2736.         <tr>

  2737.           <td></td>

  2738.           <td>)</td>

  2739.           <td></td><td></td>

  2740.         </tr>

  2741.       </table>

  2742.   </td>

  2743.   <td class="mlabels-right">

  2744. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2745.   </tr>

  2746. </table>

  2747. </div><div class="memdoc">

  2748. <p>Read data from a file starting at the current position.</p>

  2749. <dl class="params"><dt>Parameters</dt><dd>

  2750.   <table class="params">

  2751.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2752.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2753.   </table>

  2754.   </dd>

  2755. </dl>

  2756. <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>

  2757. 

  2758. </div>

  2759. </div>

  2760. <a id="a29502cd34ef186763d2196daef27df1f"></a>

  2761. <h2 class="memtitle"><span class="permalink"><a href="#a29502cd34ef186763d2196daef27df1f">&#9670;&nbsp;</a></span>readDir()</h2>

  2762. 

  2763. <div class="memitem">

  2764. <div class="memproto">

  2765. <table class="mlabels">

  2766.   <tr>

  2767.   <td class="mlabels-left">

  2768.       <table class="memname">

  2769.         <tr>

  2770.           <td class="memname">int8_t FatFile::readDir </td>

  2771.           <td>(</td>

  2772.           <td class="paramtype">DirFat_t *&#160;</td>

  2773.           <td class="paramname"><em>dir</em></td><td>)</td>

  2774.           <td></td>

  2775.         </tr>

  2776.       </table>

  2777.   </td>

  2778.   <td class="mlabels-right">

  2779. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2780.   </tr>

  2781. </table>

  2782. </div><div class="memdoc">

  2783. <p>Read the next directory entry from a directory file.</p>

  2784. <dl class="params"><dt>Parameters</dt><dd>

  2785.   <table class="params">

  2786.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The DirFat_t struct that will receive the data.</td></tr>

  2787.   </table>

  2788.   </dd>

  2789. </dl>

  2790. <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>

  2791. 

  2792. </div>

  2793. </div>

  2794. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2795. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2796. 

  2797. <div class="memitem">

  2798. <div class="memproto">

  2799. <table class="mlabels">

  2800.   <tr>

  2801.   <td class="mlabels-left">

  2802.       <table class="memname">

  2803.         <tr>

  2804.           <td class="memname">bool FatFile::remove </td>

  2805.           <td>(</td>

  2806.           <td class="paramname"></td><td>)</td>

  2807.           <td></td>

  2808.         </tr>

  2809.       </table>

  2810.   </td>

  2811.   <td class="mlabels-right">

  2812. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2813.   </tr>

  2814. </table>

  2815. </div><div class="memdoc">

  2816. <p>Remove a file.</p>

  2817. <p>The directory entry and all data for the file are deleted.</p>

  2818. <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>

  2819. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2820. 

  2821. </div>

  2822. </div>

  2823. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>

  2824. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2825. 

  2826. <div class="memitem">

  2827. <div class="memproto">

  2828. <table class="mlabels">

  2829.   <tr>

  2830.   <td class="mlabels-left">

  2831.       <table class="memname">

  2832.         <tr>

  2833.           <td class="memname">bool FatFile::remove </td>

  2834.           <td>(</td>

  2835.           <td class="paramtype">const char *&#160;</td>

  2836.           <td class="paramname"><em>path</em></td><td>)</td>

  2837.           <td></td>

  2838.         </tr>

  2839.       </table>

  2840.   </td>

  2841.   <td class="mlabels-right">

  2842. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2843.   </tr>

  2844. </table>

  2845. </div><div class="memdoc">

  2846. <p>Remove a file.</p>

  2847. <p>The directory entry and all data for the file are deleted.</p>

  2848. <dl class="params"><dt>Parameters</dt><dd>

  2849.   <table class="params">

  2850.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2851.   </table>

  2852.   </dd>

  2853. </dl>

  2854. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2855. <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>

  2856. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2857. 

  2858. </div>

  2859. </div>

  2860. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>

  2861. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2862. 

  2863. <div class="memitem">

  2864. <div class="memproto">

  2865. <table class="mlabels">

  2866.   <tr>

  2867.   <td class="mlabels-left">

  2868.       <table class="memname">

  2869.         <tr>

  2870.           <td class="memname">bool FatFile::rename </td>

  2871.           <td>(</td>

  2872.           <td class="paramtype">const char *&#160;</td>

  2873.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2874.           <td></td>

  2875.         </tr>

  2876.       </table>

  2877.   </td>

  2878.   <td class="mlabels-right">

  2879. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2880.   </tr>

  2881. </table>

  2882. </div><div class="memdoc">

  2883. <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>

  2884. <dl class="params"><dt>Parameters</dt><dd>

  2885.   <table class="params">

  2886.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2887.   </table>

  2888.   </dd>

  2889. </dl>

  2890. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2891. 

  2892. </div>

  2893. </div>

  2894. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2895. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2896. 

  2897. <div class="memitem">

  2898. <div class="memproto">

  2899. <table class="mlabels">

  2900.   <tr>

  2901.   <td class="mlabels-left">

  2902.       <table class="memname">

  2903.         <tr>

  2904.           <td class="memname">bool FatFile::rename </td>

  2905.           <td>(</td>

  2906.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2907.           <td class="paramname"><em>dirFile</em>, </td>

  2908.         </tr>

  2909.         <tr>

  2910.           <td class="paramkey"></td>

  2911.           <td></td>

  2912.           <td class="paramtype">const char *&#160;</td>

  2913.           <td class="paramname"><em>newPath</em>&#160;</td>

  2914.         </tr>

  2915.         <tr>

  2916.           <td></td>

  2917.           <td>)</td>

  2918.           <td></td><td></td>

  2919.         </tr>

  2920.       </table>

  2921.   </td>

  2922.   <td class="mlabels-right">

  2923. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2924.   </tr>

  2925. </table>

  2926. </div><div class="memdoc">

  2927. <p>Rename a file or subdirectory.</p>

  2928. <dl class="params"><dt>Parameters</dt><dd>

  2929.   <table class="params">

  2930.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2931.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2932.   </table>

  2933.   </dd>

  2934. </dl>

  2935. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2936. 

  2937. </div>

  2938. </div>

  2939. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2940. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>

  2941. 

  2942. <div class="memitem">

  2943. <div class="memproto">

  2944. <table class="mlabels">

  2945.   <tr>

  2946.   <td class="mlabels-left">

  2947.       <table class="memname">

  2948.         <tr>

  2949.           <td class="memname">void FatFile::rewind </td>

  2950.           <td>(</td>

  2951.           <td class="paramname"></td><td>)</td>

  2952.           <td></td>

  2953.         </tr>

  2954.       </table>

  2955.   </td>

  2956.   <td class="mlabels-right">

  2957. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2958.   </tr>

  2959. </table>

  2960. </div><div class="memdoc">

  2961. <p>Set the file's current position to zero. </p>

  2962. 

  2963. </div>

  2964. </div>

  2965. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  2966. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  2967. 

  2968. <div class="memitem">

  2969. <div class="memproto">

  2970. <table class="mlabels">

  2971.   <tr>

  2972.   <td class="mlabels-left">

  2973.       <table class="memname">

  2974.         <tr>

  2975.           <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>

  2976.           <td>(</td>

  2977.           <td class="paramname"></td><td>)</td>

  2978.           <td></td>

  2979.         </tr>

  2980.       </table>

  2981.   </td>

  2982.   <td class="mlabels-right">

  2983. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2984.   </tr>

  2985. </table>

  2986. </div><div class="memdoc">

  2987. <p>Rewind a file if it is a directory </p>

  2988. 

  2989. </div>

  2990. </div>

  2991. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2992. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>

  2993. 

  2994. <div class="memitem">

  2995. <div class="memproto">

  2996. <table class="mlabels">

  2997.   <tr>

  2998.   <td class="mlabels-left">

  2999.       <table class="memname">

  3000.         <tr>

  3001.           <td class="memname">bool FatFile::rmdir </td>

  3002.           <td>(</td>

  3003.           <td class="paramname"></td><td>)</td>

  3004.           <td></td>

  3005.         </tr>

  3006.       </table>

  3007.   </td>

  3008.   <td class="mlabels-right">

  3009. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3010.   </tr>

  3011. </table>

  3012. </div><div class="memdoc">

  3013. <p>Remove a directory file.</p>

  3014. <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>

  3015. <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>

  3016. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3017. 

  3018. </div>

  3019. </div>

  3020. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  3021. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>

  3022. 

  3023. <div class="memitem">

  3024. <div class="memproto">

  3025. <table class="mlabels">

  3026.   <tr>

  3027.   <td class="mlabels-left">

  3028.       <table class="memname">

  3029.         <tr>

  3030.           <td class="memname">bool FatFile::rmRfStar </td>

  3031.           <td>(</td>

  3032.           <td class="paramname"></td><td>)</td>

  3033.           <td></td>

  3034.         </tr>

  3035.       </table>

  3036.   </td>

  3037.   <td class="mlabels-right">

  3038. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3039.   </tr>

  3040. </table>

  3041. </div><div class="memdoc">

  3042. <p>Recursively delete a directory and all contained files.</p>

  3043. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  3044. <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>

  3045. <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>

  3046. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3047. 

  3048. </div>

  3049. </div>

  3050. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  3051. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  3052. 

  3053. <div class="memitem">

  3054. <div class="memproto">

  3055. <table class="mlabels">

  3056.   <tr>

  3057.   <td class="mlabels-left">

  3058.       <table class="memname">

  3059.         <tr>

  3060.           <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>

  3061.           <td>(</td>

  3062.           <td class="paramtype">uint32_t&#160;</td>

  3063.           <td class="paramname"><em>pos</em></td><td>)</td>

  3064.           <td></td>

  3065.         </tr>

  3066.       </table>

  3067.   </td>

  3068.   <td class="mlabels-right">

  3069. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3070.   </tr>

  3071. </table>

  3072. </div><div class="memdoc">

  3073. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  3074. <dl class="params"><dt>Parameters</dt><dd>

  3075.   <table class="params">

  3076.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  3077.   </table>

  3078.   </dd>

  3079. </dl>

  3080. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3081. 

  3082. </div>

  3083. </div>

  3084. <a id="a5812037ea30777cc350698ad26f2c73f"></a>

  3085. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>

  3086. 

  3087. <div class="memitem">

  3088. <div class="memproto">

  3089. <table class="mlabels">

  3090.   <tr>

  3091.   <td class="mlabels-left">

  3092.       <table class="memname">

  3093.         <tr>

  3094.           <td class="memname">bool FatFile::seekCur </td>

  3095.           <td>(</td>

  3096.           <td class="paramtype">int32_t&#160;</td>

  3097.           <td class="paramname"><em>offset</em></td><td>)</td>

  3098.           <td></td>

  3099.         </tr>

  3100.       </table>

  3101.   </td>

  3102.   <td class="mlabels-right">

  3103. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3104.   </tr>

  3105. </table>

  3106. </div><div class="memdoc">

  3107. <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>

  3108.   <table class="params">

  3109.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  3110.   </table>

  3111.   </dd>

  3112. </dl>

  3113. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3114. 

  3115. </div>

  3116. </div>

  3117. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  3118. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>

  3119. 

  3120. <div class="memitem">

  3121. <div class="memproto">

  3122. <table class="mlabels">

  3123.   <tr>

  3124.   <td class="mlabels-left">

  3125.       <table class="memname">

  3126.         <tr>

  3127.           <td class="memname">bool FatFile::seekEnd </td>

  3128.           <td>(</td>

  3129.           <td class="paramtype">int32_t&#160;</td>

  3130.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  3131.           <td></td>

  3132.         </tr>

  3133.       </table>

  3134.   </td>

  3135.   <td class="mlabels-right">

  3136. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3137.   </tr>

  3138. </table>

  3139. </div><div class="memdoc">

  3140. <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>

  3141.   <table class="params">

  3142.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  3143.   </table>

  3144.   </dd>

  3145. </dl>

  3146. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3147. 

  3148. </div>

  3149. </div>

  3150. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>

  3151. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>

  3152. 

  3153. <div class="memitem">

  3154. <div class="memproto">

  3155. <table class="mlabels">

  3156.   <tr>

  3157.   <td class="mlabels-left">

  3158.       <table class="memname">

  3159.         <tr>

  3160.           <td class="memname">bool FatFile::seekSet </td>

  3161.           <td>(</td>

  3162.           <td class="paramtype">uint32_t&#160;</td>

  3163.           <td class="paramname"><em>pos</em></td><td>)</td>

  3164.           <td></td>

  3165.         </tr>

  3166.       </table>

  3167.   </td>

  3168.   <td class="mlabels-right">

  3169. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3170.   </tr>

  3171. </table>

  3172. </div><div class="memdoc">

  3173. <p>Sets a file's position.</p>

  3174. <dl class="params"><dt>Parameters</dt><dd>

  3175.   <table class="params">

  3176.     <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>

  3177.   </table>

  3178.   </dd>

  3179. </dl>

  3180. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3181. 

  3182. </div>

  3183. </div>

  3184. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  3185. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  3186. 

  3187. <div class="memitem">

  3188. <div class="memproto">

  3189. <table class="mlabels">

  3190.   <tr>

  3191.   <td class="mlabels-left">

  3192.       <table class="memname">

  3193.         <tr>

  3194.           <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>

  3195.           <td>(</td>

  3196.           <td class="paramname"></td><td>)</td>

  3197.           <td></td>

  3198.         </tr>

  3199.       </table>

  3200.   </td>

  3201.   <td class="mlabels-right">

  3202. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3203.   </tr>

  3204. </table>

  3205. </div><div class="memdoc">

  3206. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  3207. 

  3208. </div>

  3209. </div>

  3210. <a id="a67f3dc4896c542d695e11aac927f585e"></a>

  3211. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>

  3212. 

  3213. <div class="memitem">

  3214. <div class="memproto">

  3215. <table class="mlabels">

  3216.   <tr>

  3217.   <td class="mlabels-left">

  3218.       <table class="memname">

  3219.         <tr>

  3220.           <td class="memname">bool FatFile::sync </td>

  3221.           <td>(</td>

  3222.           <td class="paramname"></td><td>)</td>

  3223.           <td></td>

  3224.         </tr>

  3225.       </table>

  3226.   </td>

  3227.   <td class="mlabels-right">

  3228. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3229.   </tr>

  3230. </table>

  3231. </div><div class="memdoc">

  3232. <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>

  3233. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3234. 

  3235. </div>

  3236. </div>

  3237. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3238. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>

  3239. 

  3240. <div class="memitem">

  3241. <div class="memproto">

  3242. <table class="mlabels">

  3243.   <tr>

  3244.   <td class="mlabels-left">

  3245.       <table class="memname">

  3246.         <tr>

  3247.           <td class="memname">bool FatFile::timestamp </td>

  3248.           <td>(</td>

  3249.           <td class="paramtype">uint8_t&#160;</td>

  3250.           <td class="paramname"><em>flags</em>, </td>

  3251.         </tr>

  3252.         <tr>

  3253.           <td class="paramkey"></td>

  3254.           <td></td>

  3255.           <td class="paramtype">uint16_t&#160;</td>

  3256.           <td class="paramname"><em>year</em>, </td>

  3257.         </tr>

  3258.         <tr>

  3259.           <td class="paramkey"></td>

  3260.           <td></td>

  3261.           <td class="paramtype">uint8_t&#160;</td>

  3262.           <td class="paramname"><em>month</em>, </td>

  3263.         </tr>

  3264.         <tr>

  3265.           <td class="paramkey"></td>

  3266.           <td></td>

  3267.           <td class="paramtype">uint8_t&#160;</td>

  3268.           <td class="paramname"><em>day</em>, </td>

  3269.         </tr>

  3270.         <tr>

  3271.           <td class="paramkey"></td>

  3272.           <td></td>

  3273.           <td class="paramtype">uint8_t&#160;</td>

  3274.           <td class="paramname"><em>hour</em>, </td>

  3275.         </tr>

  3276.         <tr>

  3277.           <td class="paramkey"></td>

  3278.           <td></td>

  3279.           <td class="paramtype">uint8_t&#160;</td>

  3280.           <td class="paramname"><em>minute</em>, </td>

  3281.         </tr>

  3282.         <tr>

  3283.           <td class="paramkey"></td>

  3284.           <td></td>

  3285.           <td class="paramtype">uint8_t&#160;</td>

  3286.           <td class="paramname"><em>second</em>&#160;</td>

  3287.         </tr>

  3288.         <tr>

  3289.           <td></td>

  3290.           <td>)</td>

  3291.           <td></td><td></td>

  3292.         </tr>

  3293.       </table>

  3294.   </td>

  3295.   <td class="mlabels-right">

  3296. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3297.   </tr>

  3298. </table>

  3299. </div><div class="memdoc">

  3300. <p>Set a file's timestamps in its directory entry.</p>

  3301. <dl class="params"><dt>Parameters</dt><dd>

  3302.   <table class="params">

  3303.     <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>

  3304.   </table>

  3305.   </dd>

  3306. </dl>

  3307. <p>T_ACCESS - Set the file's last access date.</p>

  3308. <p>T_CREATE - Set the file's creation date and time.</p>

  3309. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3310. <dl class="params"><dt>Parameters</dt><dd>

  3311.   <table class="params">

  3312.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3313.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3314.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3315.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3316.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3317.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3318.   </table>

  3319.   </dd>

  3320. </dl>

  3321. <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>

  3322. <dd>

  3323. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  3324. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3325. 

  3326. </div>

  3327. </div>

  3328. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>

  3329. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  3330. 

  3331. <div class="memitem">

  3332. <div class="memproto">

  3333. <table class="mlabels">

  3334.   <tr>

  3335.   <td class="mlabels-left">

  3336.       <table class="memname">

  3337.         <tr>

  3338.           <td class="memname">bool FatFile::truncate </td>

  3339.           <td>(</td>

  3340.           <td class="paramname"></td><td>)</td>

  3341.           <td></td>

  3342.         </tr>

  3343.       </table>

  3344.   </td>

  3345.   <td class="mlabels-right">

  3346. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3347.   </tr>

  3348. </table>

  3349. </div><div class="memdoc">

  3350. <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>

  3351. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3352. 

  3353. </div>

  3354. </div>

  3355. <a id="aa6e663098a578635d37d92e82d18d616"></a>

  3356. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  3357. 

  3358. <div class="memitem">

  3359. <div class="memproto">

  3360. <table class="mlabels">

  3361.   <tr>

  3362.   <td class="mlabels-left">

  3363.       <table class="memname">

  3364.         <tr>

  3365.           <td class="memname">bool FatFile::truncate </td>

  3366.           <td>(</td>

  3367.           <td class="paramtype">uint32_t&#160;</td>

  3368.           <td class="paramname"><em>length</em></td><td>)</td>

  3369.           <td></td>

  3370.         </tr>

  3371.       </table>

  3372.   </td>

  3373.   <td class="mlabels-right">

  3374. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3375.   </tr>

  3376. </table>

  3377. </div><div class="memdoc">

  3378. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  3379. <dl class="params"><dt>Parameters</dt><dd>

  3380.   <table class="params">

  3381.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3382.   </table>

  3383.   </dd>

  3384. </dl>

  3385. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3386. 

  3387. </div>

  3388. </div>

  3389. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  3390. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[1/4]</span></h2>

  3391. 

  3392. <div class="memitem">

  3393. <div class="memproto">

  3394. <table class="mlabels">

  3395.   <tr>

  3396.   <td class="mlabels-left">

  3397.       <table class="memname">

  3398.         <tr>

  3399.           <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>

  3400.           <td>(</td>

  3401.           <td class="paramtype">uint8_t&#160;</td>

  3402.           <td class="paramname"><em>b</em></td><td>)</td>

  3403.           <td></td>

  3404.         </tr>

  3405.       </table>

  3406.   </td>

  3407.   <td class="mlabels-right">

  3408. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3409.   </tr>

  3410. </table>

  3411. </div><div class="memdoc">

  3412. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3413.   <table class="params">

  3414.     <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>

  3415.   </table>

  3416.   </dd>

  3417. </dl>

  3418. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3419. 

  3420. </div>

  3421. </div>

  3422. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  3423. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/4]</span></h2>

  3424. 

  3425. <div class="memitem">

  3426. <div class="memproto">

  3427. <table class="mlabels">

  3428.   <tr>

  3429.   <td class="mlabels-left">

  3430.       <table class="memname">

  3431.         <tr>

  3432.           <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>

  3433.           <td>(</td>

  3434.           <td class="paramtype">const uint8_t *&#160;</td>

  3435.           <td class="paramname"><em>buffer</em>, </td>

  3436.         </tr>

  3437.         <tr>

  3438.           <td class="paramkey"></td>

  3439.           <td></td>

  3440.           <td class="paramtype">size_t&#160;</td>

  3441.           <td class="paramname"><em>size</em>&#160;</td>

  3442.         </tr>

  3443.         <tr>

  3444.           <td></td>

  3445.           <td>)</td>

  3446.           <td></td><td></td>

  3447.         </tr>

  3448.       </table>

  3449.   </td>

  3450.   <td class="mlabels-right">

  3451. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3452.   </tr>

  3453. </table>

  3454. </div><div class="memdoc">

  3455. <p>Write data to an open file.</p>

  3456. <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>

  3457. <dl class="params"><dt>Parameters</dt><dd>

  3458.   <table class="params">

  3459.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  3460.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3461.   </table>

  3462.   </dd>

  3463. </dl>

  3464. <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>

  3465. 

  3466. </div>

  3467. </div>

  3468. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>

  3469. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[3/4]</span></h2>

  3470. 

  3471. <div class="memitem">

  3472. <div class="memproto">

  3473. <table class="mlabels">

  3474.   <tr>

  3475.   <td class="mlabels-left">

  3476.       <table class="memname">

  3477.         <tr>

  3478.           <td class="memname">size_t FatFile::write </td>

  3479.           <td>(</td>

  3480.           <td class="paramtype">const char *&#160;</td>

  3481.           <td class="paramname"><em>str</em></td><td>)</td>

  3482.           <td></td>

  3483.         </tr>

  3484.       </table>

  3485.   </td>

  3486.   <td class="mlabels-right">

  3487. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3488.   </tr>

  3489. </table>

  3490. </div><div class="memdoc">

  3491. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3492.   <table class="params">

  3493.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3494.   </table>

  3495.   </dd>

  3496. </dl>

  3497. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3498. 

  3499. </div>

  3500. </div>

  3501. <a id="a5d84d871ac904a22aa48308713d14682"></a>

  3502. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[4/4]</span></h2>

  3503. 

  3504. <div class="memitem">

  3505. <div class="memproto">

  3506. <table class="mlabels">

  3507.   <tr>

  3508.   <td class="mlabels-left">

  3509.       <table class="memname">

  3510.         <tr>

  3511.           <td class="memname">size_t FatFile::write </td>

  3512.           <td>(</td>

  3513.           <td class="paramtype">const void *&#160;</td>

  3514.           <td class="paramname"><em>buf</em>, </td>

  3515.         </tr>

  3516.         <tr>

  3517.           <td class="paramkey"></td>

  3518.           <td></td>

  3519.           <td class="paramtype">size_t&#160;</td>

  3520.           <td class="paramname"><em>count</em>&#160;</td>

  3521.         </tr>

  3522.         <tr>

  3523.           <td></td>

  3524.           <td>)</td>

  3525.           <td></td><td></td>

  3526.         </tr>

  3527.       </table>

  3528.   </td>

  3529.   <td class="mlabels-right">

  3530. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3531.   </tr>

  3532. </table>

  3533. </div><div class="memdoc">

  3534. <p>Write data to an open file.</p>

  3535. <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>

  3536. <dl class="params"><dt>Parameters</dt><dd>

  3537.   <table class="params">

  3538.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3539.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  3540.   </table>

  3541.   </dd>

  3542. </dl>

  3543. <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>

  3544. 

  3545. </div>

  3546. </div>

  3547. <hr/>The documentation for this class was generated from the following file:<ul>

  3548. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  3549. </ul>

  3550. </div><!-- contents -->

  3551. <!-- start footer part -->

  3552. <hr class="footer"/><address class="footer"><small>

  3553. Generated on Mon Nov 18 2019 08:14:17 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3554. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3555. </a> 1.8.14

  3556. </small></address>

  3557. </body>

  3558. </html>