You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3563 satır
158KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: File32 Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.16 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  65. <a href="class_file32-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">File32 Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>FAT16/FAT32 file with Arduino Stream.
  71. <a href="class_file32.html#details">More...</a></p>
  72. <p><code>#include &lt;FatFile.h&gt;</code></p>
  73. <div class="dynheader">
  74. Inheritance diagram for File32:</div>
  75. <div class="dyncontent">
  76. <div class="center"><img src="class_file32__inherit__graph.png" border="0" usemap="#_file32_inherit__map" alt="Inheritance graph"/></div>
  77. <map name="_file32_inherit__map" id="_file32_inherit__map">
  78. <area shape="rect" title="FAT16/FAT32 file with Arduino Stream." alt="" coords="59,169,116,196"/>
  79. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="17,80,158,121"/>
  80. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>
  81. <area shape="rect" href="class_fat_file.html" title="Basic file class." alt="" coords="103,5,165,32"/>
  82. </map>
  83. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  84. <div class="dynheader">
  85. Collaboration diagram for File32:</div>
  86. <div class="dyncontent">
  87. <div class="center"><img src="class_file32__coll__graph.png" border="0" usemap="#_file32_coll__map" alt="Collaboration graph"/></div>
  88. <map name="_file32_coll__map" id="_file32_coll__map">
  89. <area shape="rect" title="FAT16/FAT32 file with Arduino Stream." alt="" coords="59,169,116,196"/>
  90. <area shape="rect" href="class_stream_file.html" title=" " alt="" coords="17,80,158,121"/>
  91. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>
  92. <area shape="rect" 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: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>
  111. <tr class="separator:a0853fbd44aee2798d14d8e3aed78f8bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a0afc2a1cffa238d1cb2049bfa2d8d199">createContiguous</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, uint32_t <a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a>)</td></tr>
  113. <tr class="separator:a0afc2a1cffa238d1cb2049bfa2d8d199"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a526f3dd56ce205690e45ffc86ef6f891"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a526f3dd56ce205690e45ffc86ef6f891">curCluster</a> () const</td></tr>
  115. <tr class="separator:a526f3dd56ce205690e45ffc86ef6f891"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a97e0620949f97e9b9c91ed1094d728aa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a97e0620949f97e9b9c91ed1094d728aa">curPosition</a> () const</td></tr>
  117. <tr class="separator:a97e0620949f97e9b9c91ed1094d728aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a2f4e9ab3056125b07f15d14ca26d5346"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a2f4e9ab3056125b07f15d14ca26d5346">dirEntry</a> (DirFat_t *dir)</td></tr>
  119. <tr class="separator:a2f4e9ab3056125b07f15d14ca26d5346"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ae5ec24d4a94d3780384d3f2b731c7eb9"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae5ec24d4a94d3780384d3f2b731c7eb9">dirIndex</a> ()</td></tr>
  121. <tr class="separator:ae5ec24d4a94d3780384d3f2b731c7eb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ae2ed15f05c9ccbce355e7a8d3ce8382d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ae2ed15f05c9ccbce355e7a8d3ce8382d">dirSize</a> ()</td></tr>
  123. <tr class="separator:ae2ed15f05c9ccbce355e7a8d3ce8382d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a4f01d27954ae49aeb6888ac7302f55d9">dmpFile</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint32_t pos, size_t n)</td></tr>
  125. <tr class="separator:a4f01d27954ae49aeb6888ac7302f55d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a50242f98dea0d4488ce4039a279f2a57"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a50242f98dea0d4488ce4039a279f2a57">exists</a> (const char *path)</td></tr>
  127. <tr class="separator:a50242f98dea0d4488ce4039a279f2a57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem: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:afd3e4d5a76b6751ca796fc57f4dd2be4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afd3e4d5a76b6751ca796fc57f4dd2be4">open</a> (const char *path, oflag_t oflag=0X00)</td></tr>
  189. <tr class="separator:afd3e4d5a76b6751ca796fc57f4dd2be4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a58d6ea245f1bc3ae7a6df311cd25052f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, oflag_t oflag)</td></tr>
  191. <tr class="separator:a58d6ea245f1bc3ae7a6df311cd25052f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:ab44920bb9cd5414b8e69c9dc4343394a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab44920bb9cd5414b8e69c9dc4343394a">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint16_t index, oflag_t oflag)</td></tr>
  193. <tr class="separator:ab44920bb9cd5414b8e69c9dc4343394a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:af49a42dc64cd954debb271eae5639059"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">open</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol, const char *path, oflag_t oflag)</td></tr>
  195. <tr class="separator:af49a42dc64cd954debb271eae5639059"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:a7f98b908a686574efbd7e1d20121ef9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7f98b908a686574efbd7e1d20121ef9a">openNext</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, oflag_t oflag=0X00)</td></tr>
  197. <tr class="separator:a7f98b908a686574efbd7e1d20121ef9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem: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: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>
  228. <tr class="separator:ad1cbc3aeb0f5193b7a26595966da9621"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <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>
  230. <tr class="separator:afe18a787fb8640e2d2483370c770f82f"><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: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>
  274. <tr class="separator:a081dd810835f1ebf8c23ffe92706b485"><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: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>
  278. <tr class="separator:a5d84d871ac904a22aa48308713d14682"><td class="memSeparator" colspan="2">&#160;</td></tr>
  279. <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>
  280. <tr class="separator:a0695220134825199b39dee82f18ab1ec"><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. <div class="memitem">
  297. <div class="memproto">
  298. <table class="mlabels">
  299. <tr>
  300. <td class="mlabels-left">
  301. <table class="memname">
  302. <tr>
  303. <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>
  304. <td>(</td>
  305. <td class="paramname"></td><td>)</td>
  306. <td></td>
  307. </tr>
  308. </table>
  309. </td>
  310. <td class="mlabels-right">
  311. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <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>
  316. </div>
  317. </div>
  318. <a id="a651ffa37e7e586fc3c2de8cbbd500ea6"></a>
  319. <h2 class="memtitle"><span class="permalink"><a href="#a651ffa37e7e586fc3c2de8cbbd500ea6">&#9670;&nbsp;</a></span>available32()</h2>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="mlabels">
  323. <tr>
  324. <td class="mlabels-left">
  325. <table class="memname">
  326. <tr>
  327. <td class="memname">uint32_t FatFile::available32 </td>
  328. <td>(</td>
  329. <td class="paramname"></td><td>)</td>
  330. <td></td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <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>
  340. </div>
  341. </div>
  342. <a id="a052e2c15a39b322a5307b693b8835b22"></a>
  343. <h2 class="memtitle"><span class="permalink"><a href="#a052e2c15a39b322a5307b693b8835b22">&#9670;&nbsp;</a></span>clearError()</h2>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="mlabels">
  347. <tr>
  348. <td class="mlabels-left">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">void FatFile::clearError </td>
  352. <td>(</td>
  353. <td class="paramname"></td><td>)</td>
  354. <td></td>
  355. </tr>
  356. </table>
  357. </td>
  358. <td class="mlabels-right">
  359. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>Clear all error bits. </p>
  364. </div>
  365. </div>
  366. <a id="aeca2a2eff91e6aa55fe1b0e3860c9a05"></a>
  367. <h2 class="memtitle"><span class="permalink"><a href="#aeca2a2eff91e6aa55fe1b0e3860c9a05">&#9670;&nbsp;</a></span>clearWriteError()</h2>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="mlabels">
  371. <tr>
  372. <td class="mlabels-left">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">void FatFile::clearWriteError </td>
  376. <td>(</td>
  377. <td class="paramname"></td><td>)</td>
  378. <td></td>
  379. </tr>
  380. </table>
  381. </td>
  382. <td class="mlabels-right">
  383. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  384. </tr>
  385. </table>
  386. </div><div class="memdoc">
  387. <p>Set writeError to zero </p>
  388. </div>
  389. </div>
  390. <a id="afd16af325e0642e4bff6430b7d8bb18b"></a>
  391. <h2 class="memtitle"><span class="permalink"><a href="#afd16af325e0642e4bff6430b7d8bb18b">&#9670;&nbsp;</a></span>close()</h2>
  392. <div class="memitem">
  393. <div class="memproto">
  394. <table class="mlabels">
  395. <tr>
  396. <td class="mlabels-left">
  397. <table class="memname">
  398. <tr>
  399. <td class="memname">bool FatFile::close </td>
  400. <td>(</td>
  401. <td class="paramname"></td><td>)</td>
  402. <td></td>
  403. </tr>
  404. </table>
  405. </td>
  406. <td class="mlabels-right">
  407. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. <p>Close a file and force cached data and directory information to be written to the storage device.</p>
  412. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  413. </div>
  414. </div>
  415. <a id="a12b3c5a763416ca62c70e3db74033cd0"></a>
  416. <h2 class="memtitle"><span class="permalink"><a href="#a12b3c5a763416ca62c70e3db74033cd0">&#9670;&nbsp;</a></span>contiguousRange()</h2>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="mlabels">
  420. <tr>
  421. <td class="mlabels-left">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname">bool FatFile::contiguousRange </td>
  425. <td>(</td>
  426. <td class="paramtype">uint32_t *&#160;</td>
  427. <td class="paramname"><em>bgnSector</em>, </td>
  428. </tr>
  429. <tr>
  430. <td class="paramkey"></td>
  431. <td></td>
  432. <td class="paramtype">uint32_t *&#160;</td>
  433. <td class="paramname"><em>endSector</em>&#160;</td>
  434. </tr>
  435. <tr>
  436. <td></td>
  437. <td>)</td>
  438. <td></td><td></td>
  439. </tr>
  440. </table>
  441. </td>
  442. <td class="mlabels-right">
  443. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. <p>Check for contiguous file and return its raw sector range.</p>
  448. <dl class="params"><dt>Parameters</dt><dd>
  449. <table class="params">
  450. <tr><td class="paramdir">[out]</td><td class="paramname">bgnSector</td><td>the first sector address for the file. </td></tr>
  451. <tr><td class="paramdir">[out]</td><td class="paramname">endSector</td><td>the last sector address for the file.</td></tr>
  452. </table>
  453. </dd>
  454. </dl>
  455. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  456. </div>
  457. </div>
  458. <a id="a0853fbd44aee2798d14d8e3aed78f8bf"></a>
  459. <h2 class="memtitle"><span class="permalink"><a href="#a0853fbd44aee2798d14d8e3aed78f8bf">&#9670;&nbsp;</a></span>createContiguous() <span class="overload">[1/2]</span></h2>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="mlabels">
  463. <tr>
  464. <td class="mlabels-left">
  465. <table class="memname">
  466. <tr>
  467. <td class="memname">bool FatFile::createContiguous </td>
  468. <td>(</td>
  469. <td class="paramtype">const char *&#160;</td>
  470. <td class="paramname"><em>path</em>, </td>
  471. </tr>
  472. <tr>
  473. <td class="paramkey"></td>
  474. <td></td>
  475. <td class="paramtype">uint32_t&#160;</td>
  476. <td class="paramname"><em>size</em>&#160;</td>
  477. </tr>
  478. <tr>
  479. <td></td>
  480. <td>)</td>
  481. <td></td><td></td>
  482. </tr>
  483. </table>
  484. </td>
  485. <td class="mlabels-right">
  486. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  487. </tr>
  488. </table>
  489. </div><div class="memdoc">
  490. <p>Create and open a new contiguous file of a specified size.</p>
  491. <dl class="params"><dt>Parameters</dt><dd>
  492. <table class="params">
  493. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a validfile name. </td></tr>
  494. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The desired file size.</td></tr>
  495. </table>
  496. </dd>
  497. </dl>
  498. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  499. </div>
  500. </div>
  501. <a id="a0afc2a1cffa238d1cb2049bfa2d8d199"></a>
  502. <h2 class="memtitle"><span class="permalink"><a href="#a0afc2a1cffa238d1cb2049bfa2d8d199">&#9670;&nbsp;</a></span>createContiguous() <span class="overload">[2/2]</span></h2>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <table class="mlabels">
  506. <tr>
  507. <td class="mlabels-left">
  508. <table class="memname">
  509. <tr>
  510. <td class="memname">bool FatFile::createContiguous </td>
  511. <td>(</td>
  512. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  513. <td class="paramname"><em>dirFile</em>, </td>
  514. </tr>
  515. <tr>
  516. <td class="paramkey"></td>
  517. <td></td>
  518. <td class="paramtype">const char *&#160;</td>
  519. <td class="paramname"><em>path</em>, </td>
  520. </tr>
  521. <tr>
  522. <td class="paramkey"></td>
  523. <td></td>
  524. <td class="paramtype">uint32_t&#160;</td>
  525. <td class="paramname"><em>size</em>&#160;</td>
  526. </tr>
  527. <tr>
  528. <td></td>
  529. <td>)</td>
  530. <td></td><td></td>
  531. </tr>
  532. </table>
  533. </td>
  534. <td class="mlabels-right">
  535. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  536. </tr>
  537. </table>
  538. </div><div class="memdoc">
  539. <p>Create and open a new contiguous file of a specified size.</p>
  540. <dl class="params"><dt>Parameters</dt><dd>
  541. <table class="params">
  542. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>The directory where the file will be created. </td></tr>
  543. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a validfile name. </td></tr>
  544. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The desired file size.</td></tr>
  545. </table>
  546. </dd>
  547. </dl>
  548. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  549. </div>
  550. </div>
  551. <a id="a526f3dd56ce205690e45ffc86ef6f891"></a>
  552. <h2 class="memtitle"><span class="permalink"><a href="#a526f3dd56ce205690e45ffc86ef6f891">&#9670;&nbsp;</a></span>curCluster()</h2>
  553. <div class="memitem">
  554. <div class="memproto">
  555. <table class="mlabels">
  556. <tr>
  557. <td class="mlabels-left">
  558. <table class="memname">
  559. <tr>
  560. <td class="memname">uint32_t FatFile::curCluster </td>
  561. <td>(</td>
  562. <td class="paramname"></td><td>)</td>
  563. <td> const</td>
  564. </tr>
  565. </table>
  566. </td>
  567. <td class="mlabels-right">
  568. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  569. </tr>
  570. </table>
  571. </div><div class="memdoc">
  572. <dl class="section return"><dt>Returns</dt><dd>The current cluster number for a file or directory. </dd></dl>
  573. </div>
  574. </div>
  575. <a id="a97e0620949f97e9b9c91ed1094d728aa"></a>
  576. <h2 class="memtitle"><span class="permalink"><a href="#a97e0620949f97e9b9c91ed1094d728aa">&#9670;&nbsp;</a></span>curPosition()</h2>
  577. <div class="memitem">
  578. <div class="memproto">
  579. <table class="mlabels">
  580. <tr>
  581. <td class="mlabels-left">
  582. <table class="memname">
  583. <tr>
  584. <td class="memname">uint32_t FatFile::curPosition </td>
  585. <td>(</td>
  586. <td class="paramname"></td><td>)</td>
  587. <td> const</td>
  588. </tr>
  589. </table>
  590. </td>
  591. <td class="mlabels-right">
  592. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  593. </tr>
  594. </table>
  595. </div><div class="memdoc">
  596. <dl class="section return"><dt>Returns</dt><dd>The current position for a file or directory. </dd></dl>
  597. </div>
  598. </div>
  599. <a id="a2f4e9ab3056125b07f15d14ca26d5346"></a>
  600. <h2 class="memtitle"><span class="permalink"><a href="#a2f4e9ab3056125b07f15d14ca26d5346">&#9670;&nbsp;</a></span>dirEntry()</h2>
  601. <div class="memitem">
  602. <div class="memproto">
  603. <table class="mlabels">
  604. <tr>
  605. <td class="mlabels-left">
  606. <table class="memname">
  607. <tr>
  608. <td class="memname">bool FatFile::dirEntry </td>
  609. <td>(</td>
  610. <td class="paramtype">DirFat_t *&#160;</td>
  611. <td class="paramname"><em>dir</em></td><td>)</td>
  612. <td></td>
  613. </tr>
  614. </table>
  615. </td>
  616. <td class="mlabels-right">
  617. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  618. </tr>
  619. </table>
  620. </div><div class="memdoc">
  621. <p>Return a file's directory entry.</p>
  622. <dl class="params"><dt>Parameters</dt><dd>
  623. <table class="params">
  624. <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>Location for return of the file's directory entry.</td></tr>
  625. </table>
  626. </dd>
  627. </dl>
  628. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  629. </div>
  630. </div>
  631. <a id="ae5ec24d4a94d3780384d3f2b731c7eb9"></a>
  632. <h2 class="memtitle"><span class="permalink"><a href="#ae5ec24d4a94d3780384d3f2b731c7eb9">&#9670;&nbsp;</a></span>dirIndex()</h2>
  633. <div class="memitem">
  634. <div class="memproto">
  635. <table class="mlabels">
  636. <tr>
  637. <td class="mlabels-left">
  638. <table class="memname">
  639. <tr>
  640. <td class="memname">uint16_t FatFile::dirIndex </td>
  641. <td>(</td>
  642. <td class="paramname"></td><td>)</td>
  643. <td></td>
  644. </tr>
  645. </table>
  646. </td>
  647. <td class="mlabels-right">
  648. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  649. </tr>
  650. </table>
  651. </div><div class="memdoc">
  652. <dl class="section return"><dt>Returns</dt><dd>Directory entry index. </dd></dl>
  653. </div>
  654. </div>
  655. <a id="ae2ed15f05c9ccbce355e7a8d3ce8382d"></a>
  656. <h2 class="memtitle"><span class="permalink"><a href="#ae2ed15f05c9ccbce355e7a8d3ce8382d">&#9670;&nbsp;</a></span>dirSize()</h2>
  657. <div class="memitem">
  658. <div class="memproto">
  659. <table class="mlabels">
  660. <tr>
  661. <td class="mlabels-left">
  662. <table class="memname">
  663. <tr>
  664. <td class="memname">uint32_t FatFile::dirSize </td>
  665. <td>(</td>
  666. <td class="paramname"></td><td>)</td>
  667. <td></td>
  668. </tr>
  669. </table>
  670. </td>
  671. <td class="mlabels-right">
  672. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  673. </tr>
  674. </table>
  675. </div><div class="memdoc">
  676. <dl class="section return"><dt>Returns</dt><dd>The number of bytes allocated to a directory or zero if an error occurs. </dd></dl>
  677. </div>
  678. </div>
  679. <a id="a4f01d27954ae49aeb6888ac7302f55d9"></a>
  680. <h2 class="memtitle"><span class="permalink"><a href="#a4f01d27954ae49aeb6888ac7302f55d9">&#9670;&nbsp;</a></span>dmpFile()</h2>
  681. <div class="memitem">
  682. <div class="memproto">
  683. <table class="mlabels">
  684. <tr>
  685. <td class="mlabels-left">
  686. <table class="memname">
  687. <tr>
  688. <td class="memname">void FatFile::dmpFile </td>
  689. <td>(</td>
  690. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  691. <td class="paramname"><em>pr</em>, </td>
  692. </tr>
  693. <tr>
  694. <td class="paramkey"></td>
  695. <td></td>
  696. <td class="paramtype">uint32_t&#160;</td>
  697. <td class="paramname"><em>pos</em>, </td>
  698. </tr>
  699. <tr>
  700. <td class="paramkey"></td>
  701. <td></td>
  702. <td class="paramtype">size_t&#160;</td>
  703. <td class="paramname"><em>n</em>&#160;</td>
  704. </tr>
  705. <tr>
  706. <td></td>
  707. <td>)</td>
  708. <td></td><td></td>
  709. </tr>
  710. </table>
  711. </td>
  712. <td class="mlabels-right">
  713. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  714. </tr>
  715. </table>
  716. </div><div class="memdoc">
  717. <p>Dump file in Hex </p><dl class="params"><dt>Parameters</dt><dd>
  718. <table class="params">
  719. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list. </td></tr>
  720. <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>Start position in file. </td></tr>
  721. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>number of locations to dump. </td></tr>
  722. </table>
  723. </dd>
  724. </dl>
  725. </div>
  726. </div>
  727. <a id="a50242f98dea0d4488ce4039a279f2a57"></a>
  728. <h2 class="memtitle"><span class="permalink"><a href="#a50242f98dea0d4488ce4039a279f2a57">&#9670;&nbsp;</a></span>exists()</h2>
  729. <div class="memitem">
  730. <div class="memproto">
  731. <table class="mlabels">
  732. <tr>
  733. <td class="mlabels-left">
  734. <table class="memname">
  735. <tr>
  736. <td class="memname">bool FatFile::exists </td>
  737. <td>(</td>
  738. <td class="paramtype">const char *&#160;</td>
  739. <td class="paramname"><em>path</em></td><td>)</td>
  740. <td></td>
  741. </tr>
  742. </table>
  743. </td>
  744. <td class="mlabels-right">
  745. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  746. </tr>
  747. </table>
  748. </div><div class="memdoc">
  749. <p>Test for the existence of a file in a directory</p>
  750. <dl class="params"><dt>Parameters</dt><dd>
  751. <table class="params">
  752. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  753. </table>
  754. </dd>
  755. </dl>
  756. <p>The calling instance must be an open directory file.</p>
  757. <p>dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory dirFile.</p>
  758. <dl class="section return"><dt>Returns</dt><dd>True if the file exists. </dd></dl>
  759. </div>
  760. </div>
  761. <a id="a33e0b0a8a342047f29ab8e8aae9cae14"></a>
  762. <h2 class="memtitle"><span class="permalink"><a href="#a33e0b0a8a342047f29ab8e8aae9cae14">&#9670;&nbsp;</a></span>fgetpos()</h2>
  763. <div class="memitem">
  764. <div class="memproto">
  765. <table class="mlabels">
  766. <tr>
  767. <td class="mlabels-left">
  768. <table class="memname">
  769. <tr>
  770. <td class="memname">void FatFile::fgetpos </td>
  771. <td>(</td>
  772. <td class="paramtype">fspos_t *&#160;</td>
  773. <td class="paramname"><em>pos</em></td><td>)</td>
  774. <td></td>
  775. </tr>
  776. </table>
  777. </td>
  778. <td class="mlabels-right">
  779. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  780. </tr>
  781. </table>
  782. </div><div class="memdoc">
  783. <p>get position for streams </p><dl class="params"><dt>Parameters</dt><dd>
  784. <table class="params">
  785. <tr><td class="paramdir">[out]</td><td class="paramname">pos</td><td>struct to receive position </td></tr>
  786. </table>
  787. </dd>
  788. </dl>
  789. </div>
  790. </div>
  791. <a id="a9e05a51767f7c8f70c6f337eecbdca03"></a>
  792. <h2 class="memtitle"><span class="permalink"><a href="#a9e05a51767f7c8f70c6f337eecbdca03">&#9670;&nbsp;</a></span>fgets()</h2>
  793. <div class="memitem">
  794. <div class="memproto">
  795. <table class="mlabels">
  796. <tr>
  797. <td class="mlabels-left">
  798. <table class="memname">
  799. <tr>
  800. <td class="memname">int FatFile::fgets </td>
  801. <td>(</td>
  802. <td class="paramtype">char *&#160;</td>
  803. <td class="paramname"><em>str</em>, </td>
  804. </tr>
  805. <tr>
  806. <td class="paramkey"></td>
  807. <td></td>
  808. <td class="paramtype">int&#160;</td>
  809. <td class="paramname"><em>num</em>, </td>
  810. </tr>
  811. <tr>
  812. <td class="paramkey"></td>
  813. <td></td>
  814. <td class="paramtype">char *&#160;</td>
  815. <td class="paramname"><em>delim</em> = <code><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code>&#160;</td>
  816. </tr>
  817. <tr>
  818. <td></td>
  819. <td>)</td>
  820. <td></td><td></td>
  821. </tr>
  822. </table>
  823. </td>
  824. <td class="mlabels-right">
  825. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  826. </tr>
  827. </table>
  828. </div><div class="memdoc">
  829. <p>Get a string from a file.</p>
  830. <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>
  831. <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>
  832. <dl class="params"><dt>Parameters</dt><dd>
  833. <table class="params">
  834. <tr><td class="paramdir">[out]</td><td class="paramname">str</td><td>Pointer to the array where the string is stored. </td></tr>
  835. <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>
  836. <tr><td class="paramdir">[in]</td><td class="paramname">delim</td><td>Optional set of delimiters. The default is "\n".</td></tr>
  837. </table>
  838. </dd>
  839. </dl>
  840. <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>
  841. </div>
  842. </div>
  843. <a id="a874940574b9c99e763526465adf8dc28"></a>
  844. <h2 class="memtitle"><span class="permalink"><a href="#a874940574b9c99e763526465adf8dc28">&#9670;&nbsp;</a></span>fileSize()</h2>
  845. <div class="memitem">
  846. <div class="memproto">
  847. <table class="mlabels">
  848. <tr>
  849. <td class="mlabels-left">
  850. <table class="memname">
  851. <tr>
  852. <td class="memname">uint32_t FatFile::fileSize </td>
  853. <td>(</td>
  854. <td class="paramname"></td><td>)</td>
  855. <td> const</td>
  856. </tr>
  857. </table>
  858. </td>
  859. <td class="mlabels-right">
  860. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  861. </tr>
  862. </table>
  863. </div><div class="memdoc">
  864. <dl class="section return"><dt>Returns</dt><dd>The total number of bytes in a file. </dd></dl>
  865. </div>
  866. </div>
  867. <a id="a5ac8a604863d18840f4a93c5c788b7c8"></a>
  868. <h2 class="memtitle"><span class="permalink"><a href="#a5ac8a604863d18840f4a93c5c788b7c8">&#9670;&nbsp;</a></span>firstBlock()</h2>
  869. <div class="memitem">
  870. <div class="memproto">
  871. <table class="mlabels">
  872. <tr>
  873. <td class="mlabels-left">
  874. <table class="memname">
  875. <tr>
  876. <td class="memname">uint32_t FatFile::firstBlock </td>
  877. <td>(</td>
  878. <td class="paramname"></td><td>)</td>
  879. <td> const</td>
  880. </tr>
  881. </table>
  882. </td>
  883. <td class="mlabels-right">
  884. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  885. </tr>
  886. </table>
  887. </div><div class="memdoc">
  888. <dl class="section return"><dt>Returns</dt><dd>first sector of file or zero for empty file. </dd></dl>
  889. </div>
  890. </div>
  891. <a id="af3108df387f30ca3d367dd390a04daaa"></a>
  892. <h2 class="memtitle"><span class="permalink"><a href="#af3108df387f30ca3d367dd390a04daaa">&#9670;&nbsp;</a></span>firstSector()</h2>
  893. <div class="memitem">
  894. <div class="memproto">
  895. <table class="mlabels">
  896. <tr>
  897. <td class="mlabels-left">
  898. <table class="memname">
  899. <tr>
  900. <td class="memname">uint32_t FatFile::firstSector </td>
  901. <td>(</td>
  902. <td class="paramname"></td><td>)</td>
  903. <td> const</td>
  904. </tr>
  905. </table>
  906. </td>
  907. <td class="mlabels-right">
  908. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  909. </tr>
  910. </table>
  911. </div><div class="memdoc">
  912. <dl class="section return"><dt>Returns</dt><dd>first sector of file or zero for empty file. </dd></dl>
  913. </div>
  914. </div>
  915. <a id="a32f813e659414892a58aa5157fe14f82"></a>
  916. <h2 class="memtitle"><span class="permalink"><a href="#a32f813e659414892a58aa5157fe14f82">&#9670;&nbsp;</a></span>flush()</h2>
  917. <div class="memitem">
  918. <div class="memproto">
  919. <table class="mlabels">
  920. <tr>
  921. <td class="mlabels-left">
  922. <table class="memname">
  923. <tr>
  924. <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>
  925. <td>(</td>
  926. <td class="paramname"></td><td>)</td>
  927. <td></td>
  928. </tr>
  929. </table>
  930. </td>
  931. <td class="mlabels-right">
  932. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  933. </tr>
  934. </table>
  935. </div><div class="memdoc">
  936. <p>Ensure that any bytes written to the file are saved to the SD card. </p>
  937. </div>
  938. </div>
  939. <a id="ac042c43d41ecfff4e101b88f3f82086e"></a>
  940. <h2 class="memtitle"><span class="permalink"><a href="#ac042c43d41ecfff4e101b88f3f82086e">&#9670;&nbsp;</a></span>fsetpos()</h2>
  941. <div class="memitem">
  942. <div class="memproto">
  943. <table class="mlabels">
  944. <tr>
  945. <td class="mlabels-left">
  946. <table class="memname">
  947. <tr>
  948. <td class="memname">void FatFile::fsetpos </td>
  949. <td>(</td>
  950. <td class="paramtype">const fspos_t *&#160;</td>
  951. <td class="paramname"><em>pos</em></td><td>)</td>
  952. <td></td>
  953. </tr>
  954. </table>
  955. </td>
  956. <td class="mlabels-right">
  957. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  958. </tr>
  959. </table>
  960. </div><div class="memdoc">
  961. <p>set position for streams </p><dl class="params"><dt>Parameters</dt><dd>
  962. <table class="params">
  963. <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>struct with value for new position </td></tr>
  964. </table>
  965. </dd>
  966. </dl>
  967. </div>
  968. </div>
  969. <a id="ad0dbbd083180f44c7a3ce7124d4ce19c"></a>
  970. <h2 class="memtitle"><span class="permalink"><a href="#ad0dbbd083180f44c7a3ce7124d4ce19c">&#9670;&nbsp;</a></span>getError()</h2>
  971. <div class="memitem">
  972. <div class="memproto">
  973. <table class="mlabels">
  974. <tr>
  975. <td class="mlabels-left">
  976. <table class="memname">
  977. <tr>
  978. <td class="memname">uint8_t FatFile::getError </td>
  979. <td>(</td>
  980. <td class="paramname"></td><td>)</td>
  981. <td></td>
  982. </tr>
  983. </table>
  984. </td>
  985. <td class="mlabels-right">
  986. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  987. </tr>
  988. </table>
  989. </div><div class="memdoc">
  990. <dl class="section return"><dt>Returns</dt><dd>All error bits. </dd></dl>
  991. </div>
  992. </div>
  993. <a id="aafa565e286440aab612cdb430fc01da5"></a>
  994. <h2 class="memtitle"><span class="permalink"><a href="#aafa565e286440aab612cdb430fc01da5">&#9670;&nbsp;</a></span>getName()</h2>
  995. <div class="memitem">
  996. <div class="memproto">
  997. <table class="mlabels">
  998. <tr>
  999. <td class="mlabels-left">
  1000. <table class="memname">
  1001. <tr>
  1002. <td class="memname">bool FatFile::getName </td>
  1003. <td>(</td>
  1004. <td class="paramtype">char *&#160;</td>
  1005. <td class="paramname"><em>name</em>, </td>
  1006. </tr>
  1007. <tr>
  1008. <td class="paramkey"></td>
  1009. <td></td>
  1010. <td class="paramtype">size_t&#160;</td>
  1011. <td class="paramname"><em>size</em>&#160;</td>
  1012. </tr>
  1013. <tr>
  1014. <td></td>
  1015. <td>)</td>
  1016. <td></td><td></td>
  1017. </tr>
  1018. </table>
  1019. </td>
  1020. <td class="mlabels-right">
  1021. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1022. </tr>
  1023. </table>
  1024. </div><div class="memdoc">
  1025. <p>Get a file's name followed by a zero byte.</p>
  1026. <dl class="params"><dt>Parameters</dt><dd>
  1027. <table class="params">
  1028. <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>An array of characters for the file's name. </td></tr>
  1029. <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>
  1030. </table>
  1031. </dd>
  1032. </dl>
  1033. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1034. </div>
  1035. </div>
  1036. <a id="aba30e92a66f8e0d2f815c85662772a58"></a>
  1037. <h2 class="memtitle"><span class="permalink"><a href="#aba30e92a66f8e0d2f815c85662772a58">&#9670;&nbsp;</a></span>getSFN()</h2>
  1038. <div class="memitem">
  1039. <div class="memproto">
  1040. <table class="mlabels">
  1041. <tr>
  1042. <td class="mlabels-left">
  1043. <table class="memname">
  1044. <tr>
  1045. <td class="memname">bool FatFile::getSFN </td>
  1046. <td>(</td>
  1047. <td class="paramtype">char *&#160;</td>
  1048. <td class="paramname"><em>name</em></td><td>)</td>
  1049. <td></td>
  1050. </tr>
  1051. </table>
  1052. </td>
  1053. <td class="mlabels-right">
  1054. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1055. </tr>
  1056. </table>
  1057. </div><div class="memdoc">
  1058. <p>Get a file's Short File Name followed by a zero byte.</p>
  1059. <dl class="params"><dt>Parameters</dt><dd>
  1060. <table class="params">
  1061. <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>
  1062. </table>
  1063. </dd>
  1064. </dl>
  1065. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1066. </div>
  1067. </div>
  1068. <a id="a8062c0d3a118e8d77d0310418703d5f5"></a>
  1069. <h2 class="memtitle"><span class="permalink"><a href="#a8062c0d3a118e8d77d0310418703d5f5">&#9670;&nbsp;</a></span>getWriteError()</h2>
  1070. <div class="memitem">
  1071. <div class="memproto">
  1072. <table class="mlabels">
  1073. <tr>
  1074. <td class="mlabels-left">
  1075. <table class="memname">
  1076. <tr>
  1077. <td class="memname">bool FatFile::getWriteError </td>
  1078. <td>(</td>
  1079. <td class="paramname"></td><td>)</td>
  1080. <td></td>
  1081. </tr>
  1082. </table>
  1083. </td>
  1084. <td class="mlabels-right">
  1085. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1086. </tr>
  1087. </table>
  1088. </div><div class="memdoc">
  1089. <dl class="section return"><dt>Returns</dt><dd>value of writeError </dd></dl>
  1090. </div>
  1091. </div>
  1092. <a id="a16478eafdb731e867fb627d19091c3ce"></a>
  1093. <h2 class="memtitle"><span class="permalink"><a href="#a16478eafdb731e867fb627d19091c3ce">&#9670;&nbsp;</a></span>isContiguous()</h2>
  1094. <div class="memitem">
  1095. <div class="memproto">
  1096. <table class="mlabels">
  1097. <tr>
  1098. <td class="mlabels-left">
  1099. <table class="memname">
  1100. <tr>
  1101. <td class="memname">bool FatFile::isContiguous </td>
  1102. <td>(</td>
  1103. <td class="paramname"></td><td>)</td>
  1104. <td> const</td>
  1105. </tr>
  1106. </table>
  1107. </td>
  1108. <td class="mlabels-right">
  1109. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1110. </tr>
  1111. </table>
  1112. </div><div class="memdoc">
  1113. <dl class="section return"><dt>Returns</dt><dd>True if the file is contiguous. </dd></dl>
  1114. </div>
  1115. </div>
  1116. <a id="a933360b20b496421b2bd9ee7a95563a6"></a>
  1117. <h2 class="memtitle"><span class="permalink"><a href="#a933360b20b496421b2bd9ee7a95563a6">&#9670;&nbsp;</a></span>isDir()</h2>
  1118. <div class="memitem">
  1119. <div class="memproto">
  1120. <table class="mlabels">
  1121. <tr>
  1122. <td class="mlabels-left">
  1123. <table class="memname">
  1124. <tr>
  1125. <td class="memname">bool FatFile::isDir </td>
  1126. <td>(</td>
  1127. <td class="paramname"></td><td>)</td>
  1128. <td> const</td>
  1129. </tr>
  1130. </table>
  1131. </td>
  1132. <td class="mlabels-right">
  1133. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1134. </tr>
  1135. </table>
  1136. </div><div class="memdoc">
  1137. <dl class="section return"><dt>Returns</dt><dd>True if this is a directory. </dd></dl>
  1138. </div>
  1139. </div>
  1140. <a id="a586ad44055eca4c1b2b457299b829d44"></a>
  1141. <h2 class="memtitle"><span class="permalink"><a href="#a586ad44055eca4c1b2b457299b829d44">&#9670;&nbsp;</a></span>isDirectory()</h2>
  1142. <div class="memitem">
  1143. <div class="memproto">
  1144. <table class="mlabels">
  1145. <tr>
  1146. <td class="mlabels-left">
  1147. <table class="memname">
  1148. <tr>
  1149. <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>
  1150. <td>(</td>
  1151. <td class="paramname"></td><td>)</td>
  1152. <td></td>
  1153. </tr>
  1154. </table>
  1155. </td>
  1156. <td class="mlabels-right">
  1157. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1158. </tr>
  1159. </table>
  1160. </div><div class="memdoc">
  1161. <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>
  1162. </div>
  1163. </div>
  1164. <a id="acc5a87da1a5c8cb9758bfeaa7ae47b57"></a>
  1165. <h2 class="memtitle"><span class="permalink"><a href="#acc5a87da1a5c8cb9758bfeaa7ae47b57">&#9670;&nbsp;</a></span>isFile()</h2>
  1166. <div class="memitem">
  1167. <div class="memproto">
  1168. <table class="mlabels">
  1169. <tr>
  1170. <td class="mlabels-left">
  1171. <table class="memname">
  1172. <tr>
  1173. <td class="memname">bool FatFile::isFile </td>
  1174. <td>(</td>
  1175. <td class="paramname"></td><td>)</td>
  1176. <td> const</td>
  1177. </tr>
  1178. </table>
  1179. </td>
  1180. <td class="mlabels-right">
  1181. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1182. </tr>
  1183. </table>
  1184. </div><div class="memdoc">
  1185. <dl class="section return"><dt>Returns</dt><dd>True if this is a normal file. </dd></dl>
  1186. </div>
  1187. </div>
  1188. <a id="ae216b4a2bc44a9cfb88478fa051a1fd8"></a>
  1189. <h2 class="memtitle"><span class="permalink"><a href="#ae216b4a2bc44a9cfb88478fa051a1fd8">&#9670;&nbsp;</a></span>isHidden()</h2>
  1190. <div class="memitem">
  1191. <div class="memproto">
  1192. <table class="mlabels">
  1193. <tr>
  1194. <td class="mlabels-left">
  1195. <table class="memname">
  1196. <tr>
  1197. <td class="memname">bool FatFile::isHidden </td>
  1198. <td>(</td>
  1199. <td class="paramname"></td><td>)</td>
  1200. <td> const</td>
  1201. </tr>
  1202. </table>
  1203. </td>
  1204. <td class="mlabels-right">
  1205. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1206. </tr>
  1207. </table>
  1208. </div><div class="memdoc">
  1209. <dl class="section return"><dt>Returns</dt><dd>True if this is a hidden file. </dd></dl>
  1210. </div>
  1211. </div>
  1212. <a id="af8f456ab790e818bfdd225cf6ffd40f3"></a>
  1213. <h2 class="memtitle"><span class="permalink"><a href="#af8f456ab790e818bfdd225cf6ffd40f3">&#9670;&nbsp;</a></span>isLFN()</h2>
  1214. <div class="memitem">
  1215. <div class="memproto">
  1216. <table class="mlabels">
  1217. <tr>
  1218. <td class="mlabels-left">
  1219. <table class="memname">
  1220. <tr>
  1221. <td class="memname">bool FatFile::isLFN </td>
  1222. <td>(</td>
  1223. <td class="paramname"></td><td>)</td>
  1224. <td> const</td>
  1225. </tr>
  1226. </table>
  1227. </td>
  1228. <td class="mlabels-right">
  1229. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1230. </tr>
  1231. </table>
  1232. </div><div class="memdoc">
  1233. <dl class="section return"><dt>Returns</dt><dd>true if this file has a Long File Name. </dd></dl>
  1234. </div>
  1235. </div>
  1236. <a id="a8b8a2850c086d3ce79bee64a23fbf7a6"></a>
  1237. <h2 class="memtitle"><span class="permalink"><a href="#a8b8a2850c086d3ce79bee64a23fbf7a6">&#9670;&nbsp;</a></span>isOpen()</h2>
  1238. <div class="memitem">
  1239. <div class="memproto">
  1240. <table class="mlabels">
  1241. <tr>
  1242. <td class="mlabels-left">
  1243. <table class="memname">
  1244. <tr>
  1245. <td class="memname">bool FatFile::isOpen </td>
  1246. <td>(</td>
  1247. <td class="paramname"></td><td>)</td>
  1248. <td> const</td>
  1249. </tr>
  1250. </table>
  1251. </td>
  1252. <td class="mlabels-right">
  1253. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1254. </tr>
  1255. </table>
  1256. </div><div class="memdoc">
  1257. <dl class="section return"><dt>Returns</dt><dd>True if this is an open file/directory. </dd></dl>
  1258. </div>
  1259. </div>
  1260. <a id="ae60b4cedb69c88ac641813d5edfa6b4a"></a>
  1261. <h2 class="memtitle"><span class="permalink"><a href="#ae60b4cedb69c88ac641813d5edfa6b4a">&#9670;&nbsp;</a></span>isReadable()</h2>
  1262. <div class="memitem">
  1263. <div class="memproto">
  1264. <table class="mlabels">
  1265. <tr>
  1266. <td class="mlabels-left">
  1267. <table class="memname">
  1268. <tr>
  1269. <td class="memname">bool FatFile::isReadable </td>
  1270. <td>(</td>
  1271. <td class="paramname"></td><td>)</td>
  1272. <td> const</td>
  1273. </tr>
  1274. </table>
  1275. </td>
  1276. <td class="mlabels-right">
  1277. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1278. </tr>
  1279. </table>
  1280. </div><div class="memdoc">
  1281. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
  1282. </div>
  1283. </div>
  1284. <a id="abaf639ec8f86f34aeb7e6b3615526f0b"></a>
  1285. <h2 class="memtitle"><span class="permalink"><a href="#abaf639ec8f86f34aeb7e6b3615526f0b">&#9670;&nbsp;</a></span>isReadOnly()</h2>
  1286. <div class="memitem">
  1287. <div class="memproto">
  1288. <table class="mlabels">
  1289. <tr>
  1290. <td class="mlabels-left">
  1291. <table class="memname">
  1292. <tr>
  1293. <td class="memname">bool FatFile::isReadOnly </td>
  1294. <td>(</td>
  1295. <td class="paramname"></td><td>)</td>
  1296. <td> const</td>
  1297. </tr>
  1298. </table>
  1299. </td>
  1300. <td class="mlabels-right">
  1301. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1302. </tr>
  1303. </table>
  1304. </div><div class="memdoc">
  1305. <dl class="section return"><dt>Returns</dt><dd>True if file is read-only </dd></dl>
  1306. </div>
  1307. </div>
  1308. <a id="a03421a0c28649332f55e6ca06d3aeedb"></a>
  1309. <h2 class="memtitle"><span class="permalink"><a href="#a03421a0c28649332f55e6ca06d3aeedb">&#9670;&nbsp;</a></span>isRoot()</h2>
  1310. <div class="memitem">
  1311. <div class="memproto">
  1312. <table class="mlabels">
  1313. <tr>
  1314. <td class="mlabels-left">
  1315. <table class="memname">
  1316. <tr>
  1317. <td class="memname">bool FatFile::isRoot </td>
  1318. <td>(</td>
  1319. <td class="paramname"></td><td>)</td>
  1320. <td> const</td>
  1321. </tr>
  1322. </table>
  1323. </td>
  1324. <td class="mlabels-right">
  1325. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1326. </tr>
  1327. </table>
  1328. </div><div class="memdoc">
  1329. <dl class="section return"><dt>Returns</dt><dd>True if this is the root directory. </dd></dl>
  1330. </div>
  1331. </div>
  1332. <a id="a8fda8004720ec4cc55710869dbb52e35"></a>
  1333. <h2 class="memtitle"><span class="permalink"><a href="#a8fda8004720ec4cc55710869dbb52e35">&#9670;&nbsp;</a></span>isRoot32()</h2>
  1334. <div class="memitem">
  1335. <div class="memproto">
  1336. <table class="mlabels">
  1337. <tr>
  1338. <td class="mlabels-left">
  1339. <table class="memname">
  1340. <tr>
  1341. <td class="memname">bool FatFile::isRoot32 </td>
  1342. <td>(</td>
  1343. <td class="paramname"></td><td>)</td>
  1344. <td> const</td>
  1345. </tr>
  1346. </table>
  1347. </td>
  1348. <td class="mlabels-right">
  1349. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1350. </tr>
  1351. </table>
  1352. </div><div class="memdoc">
  1353. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT32 root directory. </dd></dl>
  1354. </div>
  1355. </div>
  1356. <a id="a0cc65089f7ce6c1ff92edbf0bff59dee"></a>
  1357. <h2 class="memtitle"><span class="permalink"><a href="#a0cc65089f7ce6c1ff92edbf0bff59dee">&#9670;&nbsp;</a></span>isRootFixed()</h2>
  1358. <div class="memitem">
  1359. <div class="memproto">
  1360. <table class="mlabels">
  1361. <tr>
  1362. <td class="mlabels-left">
  1363. <table class="memname">
  1364. <tr>
  1365. <td class="memname">bool FatFile::isRootFixed </td>
  1366. <td>(</td>
  1367. <td class="paramname"></td><td>)</td>
  1368. <td> const</td>
  1369. </tr>
  1370. </table>
  1371. </td>
  1372. <td class="mlabels-right">
  1373. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1374. </tr>
  1375. </table>
  1376. </div><div class="memdoc">
  1377. <dl class="section return"><dt>Returns</dt><dd>True if this is the FAT12 of FAT16 root directory. </dd></dl>
  1378. </div>
  1379. </div>
  1380. <a id="abfd02c5d26f7d4f8739a8610116a6660"></a>
  1381. <h2 class="memtitle"><span class="permalink"><a href="#abfd02c5d26f7d4f8739a8610116a6660">&#9670;&nbsp;</a></span>isSubDir()</h2>
  1382. <div class="memitem">
  1383. <div class="memproto">
  1384. <table class="mlabels">
  1385. <tr>
  1386. <td class="mlabels-left">
  1387. <table class="memname">
  1388. <tr>
  1389. <td class="memname">bool FatFile::isSubDir </td>
  1390. <td>(</td>
  1391. <td class="paramname"></td><td>)</td>
  1392. <td> const</td>
  1393. </tr>
  1394. </table>
  1395. </td>
  1396. <td class="mlabels-right">
  1397. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1398. </tr>
  1399. </table>
  1400. </div><div class="memdoc">
  1401. <dl class="section return"><dt>Returns</dt><dd>True if this is a subdirectory. </dd></dl>
  1402. </div>
  1403. </div>
  1404. <a id="a48087bdeb6b94fc27e0f74c3d90af5a9"></a>
  1405. <h2 class="memtitle"><span class="permalink"><a href="#a48087bdeb6b94fc27e0f74c3d90af5a9">&#9670;&nbsp;</a></span>isSystem()</h2>
  1406. <div class="memitem">
  1407. <div class="memproto">
  1408. <table class="mlabels">
  1409. <tr>
  1410. <td class="mlabels-left">
  1411. <table class="memname">
  1412. <tr>
  1413. <td class="memname">bool FatFile::isSystem </td>
  1414. <td>(</td>
  1415. <td class="paramname"></td><td>)</td>
  1416. <td> const</td>
  1417. </tr>
  1418. </table>
  1419. </td>
  1420. <td class="mlabels-right">
  1421. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1422. </tr>
  1423. </table>
  1424. </div><div class="memdoc">
  1425. <dl class="section return"><dt>Returns</dt><dd>True if this is a system file. </dd></dl>
  1426. </div>
  1427. </div>
  1428. <a id="aa484d5b2b147c5f3fe0e26b6eaf11ffc"></a>
  1429. <h2 class="memtitle"><span class="permalink"><a href="#aa484d5b2b147c5f3fe0e26b6eaf11ffc">&#9670;&nbsp;</a></span>isWritable()</h2>
  1430. <div class="memitem">
  1431. <div class="memproto">
  1432. <table class="mlabels">
  1433. <tr>
  1434. <td class="mlabels-left">
  1435. <table class="memname">
  1436. <tr>
  1437. <td class="memname">bool FatFile::isWritable </td>
  1438. <td>(</td>
  1439. <td class="paramname"></td><td>)</td>
  1440. <td> const</td>
  1441. </tr>
  1442. </table>
  1443. </td>
  1444. <td class="mlabels-right">
  1445. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1446. </tr>
  1447. </table>
  1448. </div><div class="memdoc">
  1449. <dl class="section return"><dt>Returns</dt><dd>True file is writable. </dd></dl>
  1450. </div>
  1451. </div>
  1452. <a id="a94df8090f16e9666cdc53ca20f6aff90"></a>
  1453. <h2 class="memtitle"><span class="permalink"><a href="#a94df8090f16e9666cdc53ca20f6aff90">&#9670;&nbsp;</a></span>legal83Char()</h2>
  1454. <div class="memitem">
  1455. <div class="memproto">
  1456. <table class="mlabels">
  1457. <tr>
  1458. <td class="mlabels-left">
  1459. <table class="memname">
  1460. <tr>
  1461. <td class="memname">static bool FatFile::legal83Char </td>
  1462. <td>(</td>
  1463. <td class="paramtype">uint8_t&#160;</td>
  1464. <td class="paramname"><em>c</em></td><td>)</td>
  1465. <td></td>
  1466. </tr>
  1467. </table>
  1468. </td>
  1469. <td class="mlabels-right">
  1470. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
  1471. </tr>
  1472. </table>
  1473. </div><div class="memdoc">
  1474. <p>Check for a legal 8.3 character. </p><dl class="params"><dt>Parameters</dt><dd>
  1475. <table class="params">
  1476. <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Character to be checked. </td></tr>
  1477. </table>
  1478. </dd>
  1479. </dl>
  1480. <dl class="section return"><dt>Returns</dt><dd>true for a legal 8.3 character. </dd></dl>
  1481. </div>
  1482. </div>
  1483. <a id="a60ab9d16bcc778150a364c26de467de1"></a>
  1484. <h2 class="memtitle"><span class="permalink"><a href="#a60ab9d16bcc778150a364c26de467de1">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/2]</span></h2>
  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::ls </td>
  1493. <td>(</td>
  1494. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1495. <td class="paramname"><em>pr</em>, </td>
  1496. </tr>
  1497. <tr>
  1498. <td class="paramkey"></td>
  1499. <td></td>
  1500. <td class="paramtype">uint8_t&#160;</td>
  1501. <td class="paramname"><em>flags</em> = <code>0</code>, </td>
  1502. </tr>
  1503. <tr>
  1504. <td class="paramkey"></td>
  1505. <td></td>
  1506. <td class="paramtype">uint8_t&#160;</td>
  1507. <td class="paramname"><em>indent</em> = <code>0</code>&#160;</td>
  1508. </tr>
  1509. <tr>
  1510. <td></td>
  1511. <td>)</td>
  1512. <td></td><td></td>
  1513. </tr>
  1514. </table>
  1515. </td>
  1516. <td class="mlabels-right">
  1517. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1518. </tr>
  1519. </table>
  1520. </div><div class="memdoc">
  1521. <p>List directory contents.</p>
  1522. <dl class="params"><dt>Parameters</dt><dd>
  1523. <table class="params">
  1524. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1525. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1526. </table>
  1527. </dd>
  1528. </dl>
  1529. <p>LS_DATE - Print file modification date</p>
  1530. <p>LS_SIZE - Print file size.</p>
  1531. <p>LS_R - Recursive list of subdirectories.</p>
  1532. <dl class="params"><dt>Parameters</dt><dd>
  1533. <table class="params">
  1534. <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>
  1535. </table>
  1536. </dd>
  1537. </dl>
  1538. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1539. </div>
  1540. </div>
  1541. <a id="a6a11f3307da6232b5f2d11812832d93a"></a>
  1542. <h2 class="memtitle"><span class="permalink"><a href="#a6a11f3307da6232b5f2d11812832d93a">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/2]</span></h2>
  1543. <div class="memitem">
  1544. <div class="memproto">
  1545. <table class="mlabels">
  1546. <tr>
  1547. <td class="mlabels-left">
  1548. <table class="memname">
  1549. <tr>
  1550. <td class="memname">bool FatFile::ls </td>
  1551. <td>(</td>
  1552. <td class="paramtype">uint8_t&#160;</td>
  1553. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1554. <td></td>
  1555. </tr>
  1556. </table>
  1557. </td>
  1558. <td class="mlabels-right">
  1559. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1560. </tr>
  1561. </table>
  1562. </div><div class="memdoc">
  1563. <p>List directory contents.</p>
  1564. <dl class="params"><dt>Parameters</dt><dd>
  1565. <table class="params">
  1566. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1567. </table>
  1568. </dd>
  1569. </dl>
  1570. <p>LS_DATE - Print file modification date</p>
  1571. <p>LS_SIZE - Print file size.</p>
  1572. <p>LS_R - Recursive list of subdirectories.</p>
  1573. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1574. </div>
  1575. </div>
  1576. <a id="abab5b9f72cc796388dd4eed01d13d90d"></a>
  1577. <h2 class="memtitle"><span class="permalink"><a href="#abab5b9f72cc796388dd4eed01d13d90d">&#9670;&nbsp;</a></span>mkdir()</h2>
  1578. <div class="memitem">
  1579. <div class="memproto">
  1580. <table class="mlabels">
  1581. <tr>
  1582. <td class="mlabels-left">
  1583. <table class="memname">
  1584. <tr>
  1585. <td class="memname">bool FatFile::mkdir </td>
  1586. <td>(</td>
  1587. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1588. <td class="paramname"><em>dir</em>, </td>
  1589. </tr>
  1590. <tr>
  1591. <td class="paramkey"></td>
  1592. <td></td>
  1593. <td class="paramtype">const char *&#160;</td>
  1594. <td class="paramname"><em>path</em>, </td>
  1595. </tr>
  1596. <tr>
  1597. <td class="paramkey"></td>
  1598. <td></td>
  1599. <td class="paramtype">bool&#160;</td>
  1600. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1601. </tr>
  1602. <tr>
  1603. <td></td>
  1604. <td>)</td>
  1605. <td></td><td></td>
  1606. </tr>
  1607. </table>
  1608. </td>
  1609. <td class="mlabels-right">
  1610. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1611. </tr>
  1612. </table>
  1613. </div><div class="memdoc">
  1614. <p>Make a new directory.</p>
  1615. <dl class="params"><dt>Parameters</dt><dd>
  1616. <table class="params">
  1617. <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>
  1618. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the new directory.</td></tr>
  1619. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</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. </div>
  1625. </div>
  1626. <a id="a8792c863080576eb65ce6cacbe1dd931"></a>
  1627. <h2 class="memtitle"><span class="permalink"><a href="#a8792c863080576eb65ce6cacbe1dd931">&#9670;&nbsp;</a></span>name()</h2>
  1628. <div class="memitem">
  1629. <div class="memproto">
  1630. <table class="mlabels">
  1631. <tr>
  1632. <td class="mlabels-left">
  1633. <table class="memname">
  1634. <tr>
  1635. <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>
  1636. <td>(</td>
  1637. <td class="paramname"></td><td>)</td>
  1638. <td> const</td>
  1639. </tr>
  1640. </table>
  1641. </td>
  1642. <td class="mlabels-right">
  1643. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1644. </tr>
  1645. </table>
  1646. </div><div class="memdoc">
  1647. <p>No longer implemented due to Long File Names.</p>
  1648. <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>
  1649. </div>
  1650. </div>
  1651. <a id="afd3e4d5a76b6751ca796fc57f4dd2be4"></a>
  1652. <h2 class="memtitle"><span class="permalink"><a href="#afd3e4d5a76b6751ca796fc57f4dd2be4">&#9670;&nbsp;</a></span>open() <span class="overload">[1/4]</span></h2>
  1653. <div class="memitem">
  1654. <div class="memproto">
  1655. <table class="mlabels">
  1656. <tr>
  1657. <td class="mlabels-left">
  1658. <table class="memname">
  1659. <tr>
  1660. <td class="memname">bool FatFile::open </td>
  1661. <td>(</td>
  1662. <td class="paramtype">const char *&#160;</td>
  1663. <td class="paramname"><em>path</em>, </td>
  1664. </tr>
  1665. <tr>
  1666. <td class="paramkey"></td>
  1667. <td></td>
  1668. <td class="paramtype">oflag_t&#160;</td>
  1669. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1670. </tr>
  1671. <tr>
  1672. <td></td>
  1673. <td>)</td>
  1674. <td></td><td></td>
  1675. </tr>
  1676. </table>
  1677. </td>
  1678. <td class="mlabels-right">
  1679. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1680. </tr>
  1681. </table>
  1682. </div><div class="memdoc">
  1683. <p>Open a file in the current working volume.</p>
  1684. <dl class="params"><dt>Parameters</dt><dd>
  1685. <table class="params">
  1686. <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>
  1687. <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>
  1688. </table>
  1689. </dd>
  1690. </dl>
  1691. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1692. </div>
  1693. </div>
  1694. <a id="a58d6ea245f1bc3ae7a6df311cd25052f"></a>
  1695. <h2 class="memtitle"><span class="permalink"><a href="#a58d6ea245f1bc3ae7a6df311cd25052f">&#9670;&nbsp;</a></span>open() <span class="overload">[2/4]</span></h2>
  1696. <div class="memitem">
  1697. <div class="memproto">
  1698. <table class="mlabels">
  1699. <tr>
  1700. <td class="mlabels-left">
  1701. <table class="memname">
  1702. <tr>
  1703. <td class="memname">bool FatFile::open </td>
  1704. <td>(</td>
  1705. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1706. <td class="paramname"><em>dirFile</em>, </td>
  1707. </tr>
  1708. <tr>
  1709. <td class="paramkey"></td>
  1710. <td></td>
  1711. <td class="paramtype">const char *&#160;</td>
  1712. <td class="paramname"><em>path</em>, </td>
  1713. </tr>
  1714. <tr>
  1715. <td class="paramkey"></td>
  1716. <td></td>
  1717. <td class="paramtype">oflag_t&#160;</td>
  1718. <td class="paramname"><em>oflag</em>&#160;</td>
  1719. </tr>
  1720. <tr>
  1721. <td></td>
  1722. <td>)</td>
  1723. <td></td><td></td>
  1724. </tr>
  1725. </table>
  1726. </td>
  1727. <td class="mlabels-right">
  1728. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1729. </tr>
  1730. </table>
  1731. </div><div class="memdoc">
  1732. <p>Open a file or directory by name.</p>
  1733. <dl class="params"><dt>Parameters</dt><dd>
  1734. <table class="params">
  1735. <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>
  1736. <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>
  1737. <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>
  1738. </table>
  1739. </dd>
  1740. </dl>
  1741. <p>O_RDONLY - Open for reading.</p>
  1742. <p>O_READ - Same as O_RDONLY.</p>
  1743. <p>O_WRONLY - Open for writing.</p>
  1744. <p>O_WRITE - Same as O_WRONLY.</p>
  1745. <p>O_RDWR - Open for reading and writing.</p>
  1746. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>
  1747. <p>O_AT_END - Set the initial position at the end of the file.</p>
  1748. <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>
  1749. <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>
  1750. <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>
  1751. <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>
  1752. <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>
  1753. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1754. </div>
  1755. </div>
  1756. <a id="ab44920bb9cd5414b8e69c9dc4343394a"></a>
  1757. <h2 class="memtitle"><span class="permalink"><a href="#ab44920bb9cd5414b8e69c9dc4343394a">&#9670;&nbsp;</a></span>open() <span class="overload">[3/4]</span></h2>
  1758. <div class="memitem">
  1759. <div class="memproto">
  1760. <table class="mlabels">
  1761. <tr>
  1762. <td class="mlabels-left">
  1763. <table class="memname">
  1764. <tr>
  1765. <td class="memname">bool FatFile::open </td>
  1766. <td>(</td>
  1767. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1768. <td class="paramname"><em>dirFile</em>, </td>
  1769. </tr>
  1770. <tr>
  1771. <td class="paramkey"></td>
  1772. <td></td>
  1773. <td class="paramtype">uint16_t&#160;</td>
  1774. <td class="paramname"><em>index</em>, </td>
  1775. </tr>
  1776. <tr>
  1777. <td class="paramkey"></td>
  1778. <td></td>
  1779. <td class="paramtype">oflag_t&#160;</td>
  1780. <td class="paramname"><em>oflag</em>&#160;</td>
  1781. </tr>
  1782. <tr>
  1783. <td></td>
  1784. <td>)</td>
  1785. <td></td><td></td>
  1786. </tr>
  1787. </table>
  1788. </td>
  1789. <td class="mlabels-right">
  1790. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1791. </tr>
  1792. </table>
  1793. </div><div class="memdoc">
  1794. <p>Open a file by index.</p>
  1795. <dl class="params"><dt>Parameters</dt><dd>
  1796. <table class="params">
  1797. <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>
  1798. <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>
  1799. <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>
  1800. </table>
  1801. </dd>
  1802. </dl>
  1803. <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>
  1804. </div>
  1805. </div>
  1806. <a id="af49a42dc64cd954debb271eae5639059"></a>
  1807. <h2 class="memtitle"><span class="permalink"><a href="#af49a42dc64cd954debb271eae5639059">&#9670;&nbsp;</a></span>open() <span class="overload">[4/4]</span></h2>
  1808. <div class="memitem">
  1809. <div class="memproto">
  1810. <table class="mlabels">
  1811. <tr>
  1812. <td class="mlabels-left">
  1813. <table class="memname">
  1814. <tr>
  1815. <td class="memname">bool FatFile::open </td>
  1816. <td>(</td>
  1817. <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>
  1818. <td class="paramname"><em>vol</em>, </td>
  1819. </tr>
  1820. <tr>
  1821. <td class="paramkey"></td>
  1822. <td></td>
  1823. <td class="paramtype">const char *&#160;</td>
  1824. <td class="paramname"><em>path</em>, </td>
  1825. </tr>
  1826. <tr>
  1827. <td class="paramkey"></td>
  1828. <td></td>
  1829. <td class="paramtype">oflag_t&#160;</td>
  1830. <td class="paramname"><em>oflag</em>&#160;</td>
  1831. </tr>
  1832. <tr>
  1833. <td></td>
  1834. <td>)</td>
  1835. <td></td><td></td>
  1836. </tr>
  1837. </table>
  1838. </td>
  1839. <td class="mlabels-right">
  1840. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1841. </tr>
  1842. </table>
  1843. </div><div class="memdoc">
  1844. <p>Open a file in the volume root directory.</p>
  1845. <dl class="params"><dt>Parameters</dt><dd>
  1846. <table class="params">
  1847. <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>
  1848. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid name for a file to be opened.</td></tr>
  1849. <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>
  1850. </table>
  1851. </dd>
  1852. </dl>
  1853. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1854. </div>
  1855. </div>
  1856. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>
  1857. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>
  1858. <div class="memitem">
  1859. <div class="memproto">
  1860. <table class="mlabels">
  1861. <tr>
  1862. <td class="mlabels-left">
  1863. <table class="memname">
  1864. <tr>
  1865. <td class="memname">bool FatFile::openNext </td>
  1866. <td>(</td>
  1867. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  1868. <td class="paramname"><em>dirFile</em>, </td>
  1869. </tr>
  1870. <tr>
  1871. <td class="paramkey"></td>
  1872. <td></td>
  1873. <td class="paramtype">oflag_t&#160;</td>
  1874. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1875. </tr>
  1876. <tr>
  1877. <td></td>
  1878. <td>)</td>
  1879. <td></td><td></td>
  1880. </tr>
  1881. </table>
  1882. </td>
  1883. <td class="mlabels-right">
  1884. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1885. </tr>
  1886. </table>
  1887. </div><div class="memdoc">
  1888. <p>Open the next file or subdirectory in a directory.</p>
  1889. <dl class="params"><dt>Parameters</dt><dd>
  1890. <table class="params">
  1891. <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>
  1892. <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>
  1893. </table>
  1894. </dd>
  1895. </dl>
  1896. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1897. </div>
  1898. </div>
  1899. <a id="a571434707124ee554d659ec82e2ef750"></a>
  1900. <h2 class="memtitle"><span class="permalink"><a href="#a571434707124ee554d659ec82e2ef750">&#9670;&nbsp;</a></span>openNextFile()</h2>
  1901. <div class="memitem">
  1902. <div class="memproto">
  1903. <table class="mlabels">
  1904. <tr>
  1905. <td class="mlabels-left">
  1906. <table class="memname">
  1907. <tr>
  1908. <td class="memname"><a class="el" href="class_file32.html">File32</a> File32::openNextFile </td>
  1909. <td>(</td>
  1910. <td class="paramtype">oflag_t&#160;</td>
  1911. <td class="paramname"><em>oflag</em> = <code>0X00</code></td><td>)</td>
  1912. <td></td>
  1913. </tr>
  1914. </table>
  1915. </td>
  1916. <td class="mlabels-right">
  1917. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1918. </tr>
  1919. </table>
  1920. </div><div class="memdoc">
  1921. <p>Opens the next file or folder in a directory.</p>
  1922. <dl class="params"><dt>Parameters</dt><dd>
  1923. <table class="params">
  1924. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  1925. </table>
  1926. </dd>
  1927. </dl>
  1928. <dl class="section return"><dt>Returns</dt><dd>a FatStream object. </dd></dl>
  1929. </div>
  1930. </div>
  1931. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>
  1932. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>
  1933. <div class="memitem">
  1934. <div class="memproto">
  1935. <table class="mlabels">
  1936. <tr>
  1937. <td class="mlabels-left">
  1938. <table class="memname">
  1939. <tr>
  1940. <td class="memname">bool FatFile::openRoot </td>
  1941. <td>(</td>
  1942. <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>
  1943. <td class="paramname"><em>vol</em></td><td>)</td>
  1944. <td></td>
  1945. </tr>
  1946. </table>
  1947. </td>
  1948. <td class="mlabels-right">
  1949. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1950. </tr>
  1951. </table>
  1952. </div><div class="memdoc">
  1953. <p>Open a volume's root directory.</p>
  1954. <dl class="params"><dt>Parameters</dt><dd>
  1955. <table class="params">
  1956. <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>
  1957. </table>
  1958. </dd>
  1959. </dl>
  1960. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1961. </div>
  1962. </div>
  1963. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>
  1964. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>
  1965. <div class="memitem">
  1966. <div class="memproto">
  1967. <table class="mlabels">
  1968. <tr>
  1969. <td class="mlabels-left">
  1970. <table class="memname">
  1971. <tr>
  1972. <td class="memname">FatFile::operator bool </td>
  1973. <td>(</td>
  1974. <td class="paramname"></td><td>)</td>
  1975. <td></td>
  1976. </tr>
  1977. </table>
  1978. </td>
  1979. <td class="mlabels-right">
  1980. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1981. </tr>
  1982. </table>
  1983. </div><div class="memdoc">
  1984. <p>The parenthesis operator.</p>
  1985. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>
  1986. </div>
  1987. </div>
  1988. <a id="af0da96e502485133ca0cff27fa130082"></a>
  1989. <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">&#9670;&nbsp;</a></span>peek()</h2>
  1990. <div class="memitem">
  1991. <div class="memproto">
  1992. <table class="mlabels">
  1993. <tr>
  1994. <td class="mlabels-left">
  1995. <table class="memname">
  1996. <tr>
  1997. <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>
  1998. <td>(</td>
  1999. <td class="paramname"></td><td>)</td>
  2000. <td></td>
  2001. </tr>
  2002. </table>
  2003. </td>
  2004. <td class="mlabels-right">
  2005. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2006. </tr>
  2007. </table>
  2008. </div><div class="memdoc">
  2009. <p>Return the next available byte without consuming it.</p>
  2010. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>
  2011. </div>
  2012. </div>
  2013. <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>
  2014. <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">&#9670;&nbsp;</a></span>position()</h2>
  2015. <div class="memitem">
  2016. <div class="memproto">
  2017. <table class="mlabels">
  2018. <tr>
  2019. <td class="mlabels-left">
  2020. <table class="memname">
  2021. <tr>
  2022. <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>
  2023. <td>(</td>
  2024. <td class="paramname"></td><td>)</td>
  2025. <td></td>
  2026. </tr>
  2027. </table>
  2028. </td>
  2029. <td class="mlabels-right">
  2030. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2031. </tr>
  2032. </table>
  2033. </div><div class="memdoc">
  2034. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>
  2035. </div>
  2036. </div>
  2037. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>
  2038. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>
  2039. <div class="memitem">
  2040. <div class="memproto">
  2041. <table class="mlabels">
  2042. <tr>
  2043. <td class="mlabels-left">
  2044. <table class="memname">
  2045. <tr>
  2046. <td class="memname">bool FatFile::preAllocate </td>
  2047. <td>(</td>
  2048. <td class="paramtype">uint32_t&#160;</td>
  2049. <td class="paramname"><em>length</em></td><td>)</td>
  2050. <td></td>
  2051. </tr>
  2052. </table>
  2053. </td>
  2054. <td class="mlabels-right">
  2055. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2056. </tr>
  2057. </table>
  2058. </div><div class="memdoc">
  2059. <p>Allocate contiguous clusters to an empty file.</p>
  2060. <p>The file must be empty with no clusters allocated.</p>
  2061. <p>The file will contain uninitialized data.</p>
  2062. <dl class="params"><dt>Parameters</dt><dd>
  2063. <table class="params">
  2064. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>
  2065. </table>
  2066. </dd>
  2067. </dl>
  2068. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2069. </div>
  2070. </div>
  2071. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>
  2072. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>
  2073. <div class="memitem">
  2074. <div class="memproto">
  2075. <table class="mlabels">
  2076. <tr>
  2077. <td class="mlabels-left">
  2078. <table class="memname">
  2079. <tr>
  2080. <td class="memname">size_t FatFile::printAccessDate </td>
  2081. <td>(</td>
  2082. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2083. <td class="paramname"><em>pr</em></td><td>)</td>
  2084. <td></td>
  2085. </tr>
  2086. </table>
  2087. </td>
  2088. <td class="mlabels-right">
  2089. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2090. </tr>
  2091. </table>
  2092. </div><div class="memdoc">
  2093. <p>Print a file's access date</p>
  2094. <dl class="params"><dt>Parameters</dt><dd>
  2095. <table class="params">
  2096. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2097. </table>
  2098. </dd>
  2099. </dl>
  2100. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>
  2101. </div>
  2102. </div>
  2103. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>
  2104. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>
  2105. <div class="memitem">
  2106. <div class="memproto">
  2107. <table class="mlabels">
  2108. <tr>
  2109. <td class="mlabels-left">
  2110. <table class="memname">
  2111. <tr>
  2112. <td class="memname">size_t FatFile::printAccessDateTime </td>
  2113. <td>(</td>
  2114. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2115. <td class="paramname"><em>pr</em></td><td>)</td>
  2116. <td></td>
  2117. </tr>
  2118. </table>
  2119. </td>
  2120. <td class="mlabels-right">
  2121. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2122. </tr>
  2123. </table>
  2124. </div><div class="memdoc">
  2125. <p>Print a file's access date</p>
  2126. <dl class="params"><dt>Parameters</dt><dd>
  2127. <table class="params">
  2128. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2129. </table>
  2130. </dd>
  2131. </dl>
  2132. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>
  2133. </div>
  2134. </div>
  2135. <a id="ab22396a285e27b53501a0047ddd97f59"></a>
  2136. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>
  2137. <div class="memitem">
  2138. <div class="memproto">
  2139. <table class="mlabels">
  2140. <tr>
  2141. <td class="mlabels-left">
  2142. <table class="memname">
  2143. <tr>
  2144. <td class="memname">size_t FatFile::printCreateDateTime </td>
  2145. <td>(</td>
  2146. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2147. <td class="paramname"><em>pr</em></td><td>)</td>
  2148. <td></td>
  2149. </tr>
  2150. </table>
  2151. </td>
  2152. <td class="mlabels-right">
  2153. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2154. </tr>
  2155. </table>
  2156. </div><div class="memdoc">
  2157. <p>Print a file's creation date and time</p>
  2158. <dl class="params"><dt>Parameters</dt><dd>
  2159. <table class="params">
  2160. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2161. </table>
  2162. </dd>
  2163. </dl>
  2164. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>
  2165. </div>
  2166. </div>
  2167. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>
  2168. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>
  2169. <div class="memitem">
  2170. <div class="memproto">
  2171. <table class="mlabels">
  2172. <tr>
  2173. <td class="mlabels-left">
  2174. <table class="memname">
  2175. <tr>
  2176. <td class="memname">static void FatFile::printFatDate </td>
  2177. <td>(</td>
  2178. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2179. <td class="paramname"><em>pr</em>, </td>
  2180. </tr>
  2181. <tr>
  2182. <td class="paramkey"></td>
  2183. <td></td>
  2184. <td class="paramtype">uint16_t&#160;</td>
  2185. <td class="paramname"><em>fatDate</em>&#160;</td>
  2186. </tr>
  2187. <tr>
  2188. <td></td>
  2189. <td>)</td>
  2190. <td></td><td></td>
  2191. </tr>
  2192. </table>
  2193. </td>
  2194. <td class="mlabels-right">
  2195. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
  2196. </tr>
  2197. </table>
  2198. </div><div class="memdoc">
  2199. <p>Print a directory date field.</p>
  2200. <p>Format is yyyy-mm-dd.</p>
  2201. <dl class="params"><dt>Parameters</dt><dd>
  2202. <table class="params">
  2203. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>
  2204. <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>
  2205. </table>
  2206. </dd>
  2207. </dl>
  2208. </div>
  2209. </div>
  2210. <a id="a7f84d953190ea94710dad9ebb897b957"></a>
  2211. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>
  2212. <div class="memitem">
  2213. <div class="memproto">
  2214. <table class="mlabels">
  2215. <tr>
  2216. <td class="mlabels-left">
  2217. <table class="memname">
  2218. <tr>
  2219. <td class="memname">static void FatFile::printFatTime </td>
  2220. <td>(</td>
  2221. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2222. <td class="paramname"><em>pr</em>, </td>
  2223. </tr>
  2224. <tr>
  2225. <td class="paramkey"></td>
  2226. <td></td>
  2227. <td class="paramtype">uint16_t&#160;</td>
  2228. <td class="paramname"><em>fatTime</em>&#160;</td>
  2229. </tr>
  2230. <tr>
  2231. <td></td>
  2232. <td>)</td>
  2233. <td></td><td></td>
  2234. </tr>
  2235. </table>
  2236. </td>
  2237. <td class="mlabels-right">
  2238. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
  2239. </tr>
  2240. </table>
  2241. </div><div class="memdoc">
  2242. <p>Print a directory time field.</p>
  2243. <p>Format is hh:mm:ss.</p>
  2244. <dl class="params"><dt>Parameters</dt><dd>
  2245. <table class="params">
  2246. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>
  2247. <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>
  2248. </table>
  2249. </dd>
  2250. </dl>
  2251. </div>
  2252. </div>
  2253. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>
  2254. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>
  2255. <div class="memitem">
  2256. <div class="memproto">
  2257. <table class="mlabels">
  2258. <tr>
  2259. <td class="mlabels-left">
  2260. <table class="memname">
  2261. <tr>
  2262. <td class="memname">size_t FatFile::printField </td>
  2263. <td>(</td>
  2264. <td class="paramtype">double&#160;</td>
  2265. <td class="paramname"><em>value</em>, </td>
  2266. </tr>
  2267. <tr>
  2268. <td class="paramkey"></td>
  2269. <td></td>
  2270. <td class="paramtype">char&#160;</td>
  2271. <td class="paramname"><em>term</em>, </td>
  2272. </tr>
  2273. <tr>
  2274. <td class="paramkey"></td>
  2275. <td></td>
  2276. <td class="paramtype">uint8_t&#160;</td>
  2277. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  2278. </tr>
  2279. <tr>
  2280. <td></td>
  2281. <td>)</td>
  2282. <td></td><td></td>
  2283. </tr>
  2284. </table>
  2285. </td>
  2286. <td class="mlabels-right">
  2287. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2288. </tr>
  2289. </table>
  2290. </div><div class="memdoc">
  2291. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  2292. <table class="params">
  2293. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  2294. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  2295. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  2296. </table>
  2297. </dd>
  2298. </dl>
  2299. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  2300. </div>
  2301. </div>
  2302. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>
  2303. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>
  2304. <div class="memitem">
  2305. <div class="memproto">
  2306. <table class="mlabels">
  2307. <tr>
  2308. <td class="mlabels-left">
  2309. <table class="memname">
  2310. <tr>
  2311. <td class="memname">size_t FatFile::printField </td>
  2312. <td>(</td>
  2313. <td class="paramtype">float&#160;</td>
  2314. <td class="paramname"><em>value</em>, </td>
  2315. </tr>
  2316. <tr>
  2317. <td class="paramkey"></td>
  2318. <td></td>
  2319. <td class="paramtype">char&#160;</td>
  2320. <td class="paramname"><em>term</em>, </td>
  2321. </tr>
  2322. <tr>
  2323. <td class="paramkey"></td>
  2324. <td></td>
  2325. <td class="paramtype">uint8_t&#160;</td>
  2326. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  2327. </tr>
  2328. <tr>
  2329. <td></td>
  2330. <td>)</td>
  2331. <td></td><td></td>
  2332. </tr>
  2333. </table>
  2334. </td>
  2335. <td class="mlabels-right">
  2336. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2337. </tr>
  2338. </table>
  2339. </div><div class="memdoc">
  2340. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  2341. <table class="params">
  2342. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  2343. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  2344. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  2345. </table>
  2346. </dd>
  2347. </dl>
  2348. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  2349. </div>
  2350. </div>
  2351. <a id="a8f906be79086f38943cb0911310d67bf"></a>
  2352. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>
  2353. <div class="memitem">
  2354. <div class="memproto">
  2355. <div class="memtemplate">
  2356. template&lt;typename Type &gt; </div>
  2357. <table class="mlabels">
  2358. <tr>
  2359. <td class="mlabels-left">
  2360. <table class="memname">
  2361. <tr>
  2362. <td class="memname">size_t FatFile::printField </td>
  2363. <td>(</td>
  2364. <td class="paramtype">Type&#160;</td>
  2365. <td class="paramname"><em>value</em>, </td>
  2366. </tr>
  2367. <tr>
  2368. <td class="paramkey"></td>
  2369. <td></td>
  2370. <td class="paramtype">char&#160;</td>
  2371. <td class="paramname"><em>term</em>&#160;</td>
  2372. </tr>
  2373. <tr>
  2374. <td></td>
  2375. <td>)</td>
  2376. <td></td><td></td>
  2377. </tr>
  2378. </table>
  2379. </td>
  2380. <td class="mlabels-right">
  2381. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2382. </tr>
  2383. </table>
  2384. </div><div class="memdoc">
  2385. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  2386. <table class="params">
  2387. <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>
  2388. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  2389. </table>
  2390. </dd>
  2391. </dl>
  2392. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>
  2393. </div>
  2394. </div>
  2395. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>
  2396. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>
  2397. <div class="memitem">
  2398. <div class="memproto">
  2399. <table class="mlabels">
  2400. <tr>
  2401. <td class="mlabels-left">
  2402. <table class="memname">
  2403. <tr>
  2404. <td class="memname">size_t FatFile::printFileSize </td>
  2405. <td>(</td>
  2406. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2407. <td class="paramname"><em>pr</em></td><td>)</td>
  2408. <td></td>
  2409. </tr>
  2410. </table>
  2411. </td>
  2412. <td class="mlabels-right">
  2413. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2414. </tr>
  2415. </table>
  2416. </div><div class="memdoc">
  2417. <p>Print a file's size.</p>
  2418. <dl class="params"><dt>Parameters</dt><dd>
  2419. <table class="params">
  2420. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2421. </table>
  2422. </dd>
  2423. </dl>
  2424. <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>
  2425. </div>
  2426. </div>
  2427. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>
  2428. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>
  2429. <div class="memitem">
  2430. <div class="memproto">
  2431. <table class="mlabels">
  2432. <tr>
  2433. <td class="mlabels-left">
  2434. <table class="memname">
  2435. <tr>
  2436. <td class="memname">size_t FatFile::printModifyDateTime </td>
  2437. <td>(</td>
  2438. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2439. <td class="paramname"><em>pr</em></td><td>)</td>
  2440. <td></td>
  2441. </tr>
  2442. </table>
  2443. </td>
  2444. <td class="mlabels-right">
  2445. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2446. </tr>
  2447. </table>
  2448. </div><div class="memdoc">
  2449. <p>Print a file's modify date and time</p>
  2450. <dl class="params"><dt>Parameters</dt><dd>
  2451. <table class="params">
  2452. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2453. </table>
  2454. </dd>
  2455. </dl>
  2456. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>
  2457. </div>
  2458. </div>
  2459. <a id="ad1cbc3aeb0f5193b7a26595966da9621"></a>
  2460. <h2 class="memtitle"><span class="permalink"><a href="#ad1cbc3aeb0f5193b7a26595966da9621">&#9670;&nbsp;</a></span>printName() <span class="overload">[1/2]</span></h2>
  2461. <div class="memitem">
  2462. <div class="memproto">
  2463. <table class="mlabels">
  2464. <tr>
  2465. <td class="mlabels-left">
  2466. <table class="memname">
  2467. <tr>
  2468. <td class="memname">size_t FatFile::printName </td>
  2469. <td>(</td>
  2470. <td class="paramname"></td><td>)</td>
  2471. <td></td>
  2472. </tr>
  2473. </table>
  2474. </td>
  2475. <td class="mlabels-right">
  2476. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2477. </tr>
  2478. </table>
  2479. </div><div class="memdoc">
  2480. <p>Print a file's name.</p>
  2481. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2482. </div>
  2483. </div>
  2484. <a id="afe18a787fb8640e2d2483370c770f82f"></a>
  2485. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName() <span class="overload">[2/2]</span></h2>
  2486. <div class="memitem">
  2487. <div class="memproto">
  2488. <table class="mlabels">
  2489. <tr>
  2490. <td class="mlabels-left">
  2491. <table class="memname">
  2492. <tr>
  2493. <td class="memname">size_t FatFile::printName </td>
  2494. <td>(</td>
  2495. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2496. <td class="paramname"><em>pr</em></td><td>)</td>
  2497. <td></td>
  2498. </tr>
  2499. </table>
  2500. </td>
  2501. <td class="mlabels-right">
  2502. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2503. </tr>
  2504. </table>
  2505. </div><div class="memdoc">
  2506. <p>Print a file's name</p>
  2507. <dl class="params"><dt>Parameters</dt><dd>
  2508. <table class="params">
  2509. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2510. </table>
  2511. </dd>
  2512. </dl>
  2513. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2514. </div>
  2515. </div>
  2516. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>
  2517. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>
  2518. <div class="memitem">
  2519. <div class="memproto">
  2520. <table class="mlabels">
  2521. <tr>
  2522. <td class="mlabels-left">
  2523. <table class="memname">
  2524. <tr>
  2525. <td class="memname">size_t FatFile::printSFN </td>
  2526. <td>(</td>
  2527. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2528. <td class="paramname"><em>pr</em></td><td>)</td>
  2529. <td></td>
  2530. </tr>
  2531. </table>
  2532. </td>
  2533. <td class="mlabels-right">
  2534. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2535. </tr>
  2536. </table>
  2537. </div><div class="memdoc">
  2538. <p>Print a file's Short File Name.</p>
  2539. <dl class="params"><dt>Parameters</dt><dd>
  2540. <table class="params">
  2541. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>
  2542. </table>
  2543. </dd>
  2544. </dl>
  2545. <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>
  2546. </div>
  2547. </div>
  2548. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>
  2549. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>
  2550. <div class="memitem">
  2551. <div class="memproto">
  2552. <table class="mlabels">
  2553. <tr>
  2554. <td class="mlabels-left">
  2555. <table class="memname">
  2556. <tr>
  2557. <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>
  2558. <td>(</td>
  2559. <td class="paramname"></td><td>)</td>
  2560. <td></td>
  2561. </tr>
  2562. </table>
  2563. </td>
  2564. <td class="mlabels-right">
  2565. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2566. </tr>
  2567. </table>
  2568. </div><div class="memdoc">
  2569. <p>Read the next byte from a file.</p>
  2570. <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>
  2571. </div>
  2572. </div>
  2573. <a id="aba893af8107a18017482d2311b066187"></a>
  2574. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>
  2575. <div class="memitem">
  2576. <div class="memproto">
  2577. <table class="mlabels">
  2578. <tr>
  2579. <td class="mlabels-left">
  2580. <table class="memname">
  2581. <tr>
  2582. <td class="memname">int FatFile::read </td>
  2583. <td>(</td>
  2584. <td class="paramtype">void *&#160;</td>
  2585. <td class="paramname"><em>buf</em>, </td>
  2586. </tr>
  2587. <tr>
  2588. <td class="paramkey"></td>
  2589. <td></td>
  2590. <td class="paramtype">size_t&#160;</td>
  2591. <td class="paramname"><em>count</em>&#160;</td>
  2592. </tr>
  2593. <tr>
  2594. <td></td>
  2595. <td>)</td>
  2596. <td></td><td></td>
  2597. </tr>
  2598. </table>
  2599. </td>
  2600. <td class="mlabels-right">
  2601. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2602. </tr>
  2603. </table>
  2604. </div><div class="memdoc">
  2605. <p>Read data from a file starting at the current position.</p>
  2606. <dl class="params"><dt>Parameters</dt><dd>
  2607. <table class="params">
  2608. <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>
  2609. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>
  2610. </table>
  2611. </dd>
  2612. </dl>
  2613. <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>
  2614. </div>
  2615. </div>
  2616. <a id="a29502cd34ef186763d2196daef27df1f"></a>
  2617. <h2 class="memtitle"><span class="permalink"><a href="#a29502cd34ef186763d2196daef27df1f">&#9670;&nbsp;</a></span>readDir()</h2>
  2618. <div class="memitem">
  2619. <div class="memproto">
  2620. <table class="mlabels">
  2621. <tr>
  2622. <td class="mlabels-left">
  2623. <table class="memname">
  2624. <tr>
  2625. <td class="memname">int8_t FatFile::readDir </td>
  2626. <td>(</td>
  2627. <td class="paramtype">DirFat_t *&#160;</td>
  2628. <td class="paramname"><em>dir</em></td><td>)</td>
  2629. <td></td>
  2630. </tr>
  2631. </table>
  2632. </td>
  2633. <td class="mlabels-right">
  2634. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2635. </tr>
  2636. </table>
  2637. </div><div class="memdoc">
  2638. <p>Read the next directory entry from a directory file.</p>
  2639. <dl class="params"><dt>Parameters</dt><dd>
  2640. <table class="params">
  2641. <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The DirFat_t struct that will receive the data.</td></tr>
  2642. </table>
  2643. </dd>
  2644. </dl>
  2645. <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>
  2646. </div>
  2647. </div>
  2648. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>
  2649. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>
  2650. <div class="memitem">
  2651. <div class="memproto">
  2652. <table class="mlabels">
  2653. <tr>
  2654. <td class="mlabels-left">
  2655. <table class="memname">
  2656. <tr>
  2657. <td class="memname">bool FatFile::remove </td>
  2658. <td>(</td>
  2659. <td class="paramname"></td><td>)</td>
  2660. <td></td>
  2661. </tr>
  2662. </table>
  2663. </td>
  2664. <td class="mlabels-right">
  2665. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2666. </tr>
  2667. </table>
  2668. </div><div class="memdoc">
  2669. <p>Remove a file.</p>
  2670. <p>The directory entry and all data for the file are deleted.</p>
  2671. <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>
  2672. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2673. </div>
  2674. </div>
  2675. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>
  2676. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>
  2677. <div class="memitem">
  2678. <div class="memproto">
  2679. <table class="mlabels">
  2680. <tr>
  2681. <td class="mlabels-left">
  2682. <table class="memname">
  2683. <tr>
  2684. <td class="memname">bool FatFile::remove </td>
  2685. <td>(</td>
  2686. <td class="paramtype">const char *&#160;</td>
  2687. <td class="paramname"><em>path</em></td><td>)</td>
  2688. <td></td>
  2689. </tr>
  2690. </table>
  2691. </td>
  2692. <td class="mlabels-right">
  2693. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2694. </tr>
  2695. </table>
  2696. </div><div class="memdoc">
  2697. <p>Remove a file.</p>
  2698. <p>The directory entry and all data for the file are deleted.</p>
  2699. <dl class="params"><dt>Parameters</dt><dd>
  2700. <table class="params">
  2701. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>
  2702. </table>
  2703. </dd>
  2704. </dl>
  2705. <p>Example use: dirFile.remove(filenameToRemove);</p>
  2706. <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>
  2707. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2708. </div>
  2709. </div>
  2710. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>
  2711. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>
  2712. <div class="memitem">
  2713. <div class="memproto">
  2714. <table class="mlabels">
  2715. <tr>
  2716. <td class="mlabels-left">
  2717. <table class="memname">
  2718. <tr>
  2719. <td class="memname">bool FatFile::rename </td>
  2720. <td>(</td>
  2721. <td class="paramtype">const char *&#160;</td>
  2722. <td class="paramname"><em>newPath</em></td><td>)</td>
  2723. <td></td>
  2724. </tr>
  2725. </table>
  2726. </td>
  2727. <td class="mlabels-right">
  2728. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2729. </tr>
  2730. </table>
  2731. </div><div class="memdoc">
  2732. <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>
  2733. <dl class="params"><dt>Parameters</dt><dd>
  2734. <table class="params">
  2735. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
  2736. </table>
  2737. </dd>
  2738. </dl>
  2739. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2740. </div>
  2741. </div>
  2742. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>
  2743. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>
  2744. <div class="memitem">
  2745. <div class="memproto">
  2746. <table class="mlabels">
  2747. <tr>
  2748. <td class="mlabels-left">
  2749. <table class="memname">
  2750. <tr>
  2751. <td class="memname">bool FatFile::rename </td>
  2752. <td>(</td>
  2753. <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>
  2754. <td class="paramname"><em>dirFile</em>, </td>
  2755. </tr>
  2756. <tr>
  2757. <td class="paramkey"></td>
  2758. <td></td>
  2759. <td class="paramtype">const char *&#160;</td>
  2760. <td class="paramname"><em>newPath</em>&#160;</td>
  2761. </tr>
  2762. <tr>
  2763. <td></td>
  2764. <td>)</td>
  2765. <td></td><td></td>
  2766. </tr>
  2767. </table>
  2768. </td>
  2769. <td class="mlabels-right">
  2770. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2771. </tr>
  2772. </table>
  2773. </div><div class="memdoc">
  2774. <p>Rename a file or subdirectory.</p>
  2775. <dl class="params"><dt>Parameters</dt><dd>
  2776. <table class="params">
  2777. <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>
  2778. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>
  2779. </table>
  2780. </dd>
  2781. </dl>
  2782. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2783. </div>
  2784. </div>
  2785. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>
  2786. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>
  2787. <div class="memitem">
  2788. <div class="memproto">
  2789. <table class="mlabels">
  2790. <tr>
  2791. <td class="mlabels-left">
  2792. <table class="memname">
  2793. <tr>
  2794. <td class="memname">void FatFile::rewind </td>
  2795. <td>(</td>
  2796. <td class="paramname"></td><td>)</td>
  2797. <td></td>
  2798. </tr>
  2799. </table>
  2800. </td>
  2801. <td class="mlabels-right">
  2802. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2803. </tr>
  2804. </table>
  2805. </div><div class="memdoc">
  2806. <p>Set the file's current position to zero. </p>
  2807. </div>
  2808. </div>
  2809. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>
  2810. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>
  2811. <div class="memitem">
  2812. <div class="memproto">
  2813. <table class="mlabels">
  2814. <tr>
  2815. <td class="mlabels-left">
  2816. <table class="memname">
  2817. <tr>
  2818. <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>
  2819. <td>(</td>
  2820. <td class="paramname"></td><td>)</td>
  2821. <td></td>
  2822. </tr>
  2823. </table>
  2824. </td>
  2825. <td class="mlabels-right">
  2826. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2827. </tr>
  2828. </table>
  2829. </div><div class="memdoc">
  2830. <p>Rewind a file if it is a directory </p>
  2831. </div>
  2832. </div>
  2833. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>
  2834. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>
  2835. <div class="memitem">
  2836. <div class="memproto">
  2837. <table class="mlabels">
  2838. <tr>
  2839. <td class="mlabels-left">
  2840. <table class="memname">
  2841. <tr>
  2842. <td class="memname">bool FatFile::rmdir </td>
  2843. <td>(</td>
  2844. <td class="paramname"></td><td>)</td>
  2845. <td></td>
  2846. </tr>
  2847. </table>
  2848. </td>
  2849. <td class="mlabels-right">
  2850. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2851. </tr>
  2852. </table>
  2853. </div><div class="memdoc">
  2854. <p>Remove a directory file.</p>
  2855. <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>
  2856. <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>
  2857. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2858. </div>
  2859. </div>
  2860. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>
  2861. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>
  2862. <div class="memitem">
  2863. <div class="memproto">
  2864. <table class="mlabels">
  2865. <tr>
  2866. <td class="mlabels-left">
  2867. <table class="memname">
  2868. <tr>
  2869. <td class="memname">bool FatFile::rmRfStar </td>
  2870. <td>(</td>
  2871. <td class="paramname"></td><td>)</td>
  2872. <td></td>
  2873. </tr>
  2874. </table>
  2875. </td>
  2876. <td class="mlabels-right">
  2877. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  2878. </tr>
  2879. </table>
  2880. </div><div class="memdoc">
  2881. <p>Recursively delete a directory and all contained files.</p>
  2882. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>
  2883. <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>
  2884. <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>
  2885. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2886. </div>
  2887. </div>
  2888. <a id="a773ee6f661fc689a5187f51cb5498086"></a>
  2889. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>
  2890. <div class="memitem">
  2891. <div class="memproto">
  2892. <table class="mlabels">
  2893. <tr>
  2894. <td class="mlabels-left">
  2895. <table class="memname">
  2896. <tr>
  2897. <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>
  2898. <td>(</td>
  2899. <td class="paramtype">uint32_t&#160;</td>
  2900. <td class="paramname"><em>pos</em></td><td>)</td>
  2901. <td></td>
  2902. </tr>
  2903. </table>
  2904. </td>
  2905. <td class="mlabels-right">
  2906. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2907. </tr>
  2908. </table>
  2909. </div><div class="memdoc">
  2910. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>
  2911. <dl class="params"><dt>Parameters</dt><dd>
  2912. <table class="params">
  2913. <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>
  2914. </table>
  2915. </dd>
  2916. </dl>
  2917. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2918. </div>
  2919. </div>
  2920. <a id="a5812037ea30777cc350698ad26f2c73f"></a>
  2921. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>
  2922. <div class="memitem">
  2923. <div class="memproto">
  2924. <table class="mlabels">
  2925. <tr>
  2926. <td class="mlabels-left">
  2927. <table class="memname">
  2928. <tr>
  2929. <td class="memname">bool FatFile::seekCur </td>
  2930. <td>(</td>
  2931. <td class="paramtype">int32_t&#160;</td>
  2932. <td class="paramname"><em>offset</em></td><td>)</td>
  2933. <td></td>
  2934. </tr>
  2935. </table>
  2936. </td>
  2937. <td class="mlabels-right">
  2938. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2939. </tr>
  2940. </table>
  2941. </div><div class="memdoc">
  2942. <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>
  2943. <table class="params">
  2944. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>
  2945. </table>
  2946. </dd>
  2947. </dl>
  2948. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2949. </div>
  2950. </div>
  2951. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>
  2952. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>
  2953. <div class="memitem">
  2954. <div class="memproto">
  2955. <table class="mlabels">
  2956. <tr>
  2957. <td class="mlabels-left">
  2958. <table class="memname">
  2959. <tr>
  2960. <td class="memname">bool FatFile::seekEnd </td>
  2961. <td>(</td>
  2962. <td class="paramtype">int32_t&#160;</td>
  2963. <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>
  2964. <td></td>
  2965. </tr>
  2966. </table>
  2967. </td>
  2968. <td class="mlabels-right">
  2969. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2970. </tr>
  2971. </table>
  2972. </div><div class="memdoc">
  2973. <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>
  2974. <table class="params">
  2975. <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>
  2976. </table>
  2977. </dd>
  2978. </dl>
  2979. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  2980. </div>
  2981. </div>
  2982. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>
  2983. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>
  2984. <div class="memitem">
  2985. <div class="memproto">
  2986. <table class="mlabels">
  2987. <tr>
  2988. <td class="mlabels-left">
  2989. <table class="memname">
  2990. <tr>
  2991. <td class="memname">bool FatFile::seekSet </td>
  2992. <td>(</td>
  2993. <td class="paramtype">uint32_t&#160;</td>
  2994. <td class="paramname"><em>pos</em></td><td>)</td>
  2995. <td></td>
  2996. </tr>
  2997. </table>
  2998. </td>
  2999. <td class="mlabels-right">
  3000. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  3001. </tr>
  3002. </table>
  3003. </div><div class="memdoc">
  3004. <p>Sets a file's position.</p>
  3005. <dl class="params"><dt>Parameters</dt><dd>
  3006. <table class="params">
  3007. <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>
  3008. </table>
  3009. </dd>
  3010. </dl>
  3011. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  3012. </div>
  3013. </div>
  3014. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>
  3015. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>
  3016. <div class="memitem">
  3017. <div class="memproto">
  3018. <table class="mlabels">
  3019. <tr>
  3020. <td class="mlabels-left">
  3021. <table class="memname">
  3022. <tr>
  3023. <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>
  3024. <td>(</td>
  3025. <td class="paramname"></td><td>)</td>
  3026. <td></td>
  3027. </tr>
  3028. </table>
  3029. </td>
  3030. <td class="mlabels-right">
  3031. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  3032. </tr>
  3033. </table>
  3034. </div><div class="memdoc">
  3035. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>
  3036. </div>
  3037. </div>
  3038. <a id="a67f3dc4896c542d695e11aac927f585e"></a>
  3039. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>
  3040. <div class="memitem">
  3041. <div class="memproto">
  3042. <table class="mlabels">
  3043. <tr>
  3044. <td class="mlabels-left">
  3045. <table class="memname">
  3046. <tr>
  3047. <td class="memname">bool FatFile::sync </td>
  3048. <td>(</td>
  3049. <td class="paramname"></td><td>)</td>
  3050. <td></td>
  3051. </tr>
  3052. </table>
  3053. </td>
  3054. <td class="mlabels-right">
  3055. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  3056. </tr>
  3057. </table>
  3058. </div><div class="memdoc">
  3059. <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>
  3060. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  3061. </div>
  3062. </div>
  3063. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>
  3064. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>
  3065. <div class="memitem">
  3066. <div class="memproto">
  3067. <table class="mlabels">
  3068. <tr>
  3069. <td class="mlabels-left">
  3070. <table class="memname">
  3071. <tr>
  3072. <td class="memname">bool FatFile::timestamp </td>
  3073. <td>(</td>
  3074. <td class="paramtype">uint8_t&#160;</td>
  3075. <td class="paramname"><em>flags</em>, </td>
  3076. </tr>
  3077. <tr>
  3078. <td class="paramkey"></td>
  3079. <td></td>
  3080. <td class="paramtype">uint16_t&#160;</td>
  3081. <td class="paramname"><em>year</em>, </td>
  3082. </tr>
  3083. <tr>
  3084. <td class="paramkey"></td>
  3085. <td></td>
  3086. <td class="paramtype">uint8_t&#160;</td>
  3087. <td class="paramname"><em>month</em>, </td>
  3088. </tr>
  3089. <tr>
  3090. <td class="paramkey"></td>
  3091. <td></td>
  3092. <td class="paramtype">uint8_t&#160;</td>
  3093. <td class="paramname"><em>day</em>, </td>
  3094. </tr>
  3095. <tr>
  3096. <td class="paramkey"></td>
  3097. <td></td>
  3098. <td class="paramtype">uint8_t&#160;</td>
  3099. <td class="paramname"><em>hour</em>, </td>
  3100. </tr>
  3101. <tr>
  3102. <td class="paramkey"></td>
  3103. <td></td>
  3104. <td class="paramtype">uint8_t&#160;</td>
  3105. <td class="paramname"><em>minute</em>, </td>
  3106. </tr>
  3107. <tr>
  3108. <td class="paramkey"></td>
  3109. <td></td>
  3110. <td class="paramtype">uint8_t&#160;</td>
  3111. <td class="paramname"><em>second</em>&#160;</td>
  3112. </tr>
  3113. <tr>
  3114. <td></td>
  3115. <td>)</td>
  3116. <td></td><td></td>
  3117. </tr>
  3118. </table>
  3119. </td>
  3120. <td class="mlabels-right">
  3121. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  3122. </tr>
  3123. </table>
  3124. </div><div class="memdoc">
  3125. <p>Set a file's timestamps in its directory entry.</p>
  3126. <dl class="params"><dt>Parameters</dt><dd>
  3127. <table class="params">
  3128. <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>
  3129. </table>
  3130. </dd>
  3131. </dl>
  3132. <p>T_ACCESS - Set the file's last access date.</p>
  3133. <p>T_CREATE - Set the file's creation date and time.</p>
  3134. <p>T_WRITE - Set the file's last write/modification date and time.</p>
  3135. <dl class="params"><dt>Parameters</dt><dd>
  3136. <table class="params">
  3137. <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>
  3138. <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>
  3139. <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>
  3140. <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>
  3141. <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>
  3142. <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>
  3143. </table>
  3144. </dd>
  3145. </dl>
  3146. <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>
  3147. <dd>
  3148. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>
  3149. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  3150. </div>
  3151. </div>
  3152. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>
  3153. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>
  3154. <div class="memitem">
  3155. <div class="memproto">
  3156. <table class="mlabels">
  3157. <tr>
  3158. <td class="mlabels-left">
  3159. <table class="memname">
  3160. <tr>
  3161. <td class="memname">bool FatFile::truncate </td>
  3162. <td>(</td>
  3163. <td class="paramname"></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>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>
  3174. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  3175. </div>
  3176. </div>
  3177. <a id="aa6e663098a578635d37d92e82d18d616"></a>
  3178. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>
  3179. <div class="memitem">
  3180. <div class="memproto">
  3181. <table class="mlabels">
  3182. <tr>
  3183. <td class="mlabels-left">
  3184. <table class="memname">
  3185. <tr>
  3186. <td class="memname">bool FatFile::truncate </td>
  3187. <td>(</td>
  3188. <td class="paramtype">uint32_t&#160;</td>
  3189. <td class="paramname"><em>length</em></td><td>)</td>
  3190. <td></td>
  3191. </tr>
  3192. </table>
  3193. </td>
  3194. <td class="mlabels-right">
  3195. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  3196. </tr>
  3197. </table>
  3198. </div><div class="memdoc">
  3199. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>
  3200. <dl class="params"><dt>Parameters</dt><dd>
  3201. <table class="params">
  3202. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  3203. </table>
  3204. </dd>
  3205. </dl>
  3206. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  3207. </div>
  3208. </div>
  3209. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>
  3210. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[1/4]</span></h2>
  3211. <div class="memitem">
  3212. <div class="memproto">
  3213. <table class="mlabels">
  3214. <tr>
  3215. <td class="mlabels-left">
  3216. <table class="memname">
  3217. <tr>
  3218. <td class="memname">size_t FatFile::write </td>
  3219. <td>(</td>
  3220. <td class="paramtype">const char *&#160;</td>
  3221. <td class="paramname"><em>str</em></td><td>)</td>
  3222. <td></td>
  3223. </tr>
  3224. </table>
  3225. </td>
  3226. <td class="mlabels-right">
  3227. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  3228. </tr>
  3229. </table>
  3230. </div><div class="memdoc">
  3231. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>
  3232. <table class="params">
  3233. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>
  3234. </table>
  3235. </dd>
  3236. </dl>
  3237. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>
  3238. </div>
  3239. </div>
  3240. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>
  3241. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/4]</span></h2>
  3242. <div class="memitem">
  3243. <div class="memproto">
  3244. <table class="mlabels">
  3245. <tr>
  3246. <td class="mlabels-left">
  3247. <table class="memname">
  3248. <tr>
  3249. <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>
  3250. <td>(</td>
  3251. <td class="paramtype">const uint8_t *&#160;</td>
  3252. <td class="paramname"><em>buffer</em>, </td>
  3253. </tr>
  3254. <tr>
  3255. <td class="paramkey"></td>
  3256. <td></td>
  3257. <td class="paramtype">size_t&#160;</td>
  3258. <td class="paramname"><em>size</em>&#160;</td>
  3259. </tr>
  3260. <tr>
  3261. <td></td>
  3262. <td>)</td>
  3263. <td></td><td></td>
  3264. </tr>
  3265. </table>
  3266. </td>
  3267. <td class="mlabels-right">
  3268. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  3269. </tr>
  3270. </table>
  3271. </div><div class="memdoc">
  3272. <p>Write data to an open file.</p>
  3273. <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>
  3274. <dl class="params"><dt>Parameters</dt><dd>
  3275. <table class="params">
  3276. <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>
  3277. <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>
  3278. </table>
  3279. </dd>
  3280. </dl>
  3281. <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>
  3282. </div>
  3283. </div>
  3284. <a id="a5d84d871ac904a22aa48308713d14682"></a>
  3285. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[3/4]</span></h2>
  3286. <div class="memitem">
  3287. <div class="memproto">
  3288. <table class="mlabels">
  3289. <tr>
  3290. <td class="mlabels-left">
  3291. <table class="memname">
  3292. <tr>
  3293. <td class="memname">size_t FatFile::write </td>
  3294. <td>(</td>
  3295. <td class="paramtype">const void *&#160;</td>
  3296. <td class="paramname"><em>buf</em>, </td>
  3297. </tr>
  3298. <tr>
  3299. <td class="paramkey"></td>
  3300. <td></td>
  3301. <td class="paramtype">size_t&#160;</td>
  3302. <td class="paramname"><em>count</em>&#160;</td>
  3303. </tr>
  3304. <tr>
  3305. <td></td>
  3306. <td>)</td>
  3307. <td></td><td></td>
  3308. </tr>
  3309. </table>
  3310. </td>
  3311. <td class="mlabels-right">
  3312. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  3313. </tr>
  3314. </table>
  3315. </div><div class="memdoc">
  3316. <p>Write data to an open file.</p>
  3317. <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>
  3318. <dl class="params"><dt>Parameters</dt><dd>
  3319. <table class="params">
  3320. <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>
  3321. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>
  3322. </table>
  3323. </dd>
  3324. </dl>
  3325. <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>
  3326. </div>
  3327. </div>
  3328. <a id="a0695220134825199b39dee82f18ab1ec"></a>
  3329. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[4/4]</span></h2>
  3330. <div class="memitem">
  3331. <div class="memproto">
  3332. <table class="mlabels">
  3333. <tr>
  3334. <td class="mlabels-left">
  3335. <table class="memname">
  3336. <tr>
  3337. <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>
  3338. <td>(</td>
  3339. <td class="paramtype">uint8_t&#160;</td>
  3340. <td class="paramname"><em>b</em></td><td>)</td>
  3341. <td></td>
  3342. </tr>
  3343. </table>
  3344. </td>
  3345. <td class="mlabels-right">
  3346. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  3347. </tr>
  3348. </table>
  3349. </div><div class="memdoc">
  3350. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>
  3351. <table class="params">
  3352. <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>
  3353. </table>
  3354. </dd>
  3355. </dl>
  3356. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>
  3357. </div>
  3358. </div>
  3359. <hr/>The documentation for this class was generated from the following file:<ul>
  3360. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>
  3361. </ul>
  3362. </div><!-- contents -->
  3363. <!-- start footer part -->
  3364. <hr class="footer"/><address class="footer"><small>
  3365. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  3366. <img class="footer" src="doxygen.png" alt="doxygen"/>
  3367. </a> 1.8.16
  3368. </small></address>
  3369. </body>
  3370. </html>