visus
/
teensy-sdfat
Следить 1
В избранное 0
Форкнуть 0
Код Задачи 0 Pull Request'ы 0 Релизы 0 Вики Активность
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
49 коммитов
1 ветка
Дерево: 5cb74d4e33
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из '5cb74d4e33'
${ noResults }
teensy-sdfat/extras/html/class_file32.html

3463 lines
153KB
Исходник Blame История 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

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

  68.   <div class="headertitle">

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

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

  71. <div class="contents">

  72. 

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

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

  75. 

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

  77. <div class="dynheader">

  78. Inheritance diagram for File32:</div>

  79. <div class="dyncontent">

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

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

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

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

  84. </map>

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

  86. <div class="dynheader">

  87. Collaboration diagram for File32:</div>

  88. <div class="dyncontent">

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

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

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

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

  93. </map>

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

  95. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  119. <tr class="separator:a6858d18c807411a071fd6d1b39d50087"><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#ab4f210a7e2149c6c531486f1713c647b">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: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  178. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint8_t flags=0, uint8_t indent=0)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  223. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  280. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint16_t fatDate)</td></tr>

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

  282. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint16_t fatTime)</td></tr>

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

  284. </table>

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

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

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

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

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

  290. 

  291. <div class="memitem">

  292. <div class="memproto">

  293. <table class="mlabels">

  294.   <tr>

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

  296.       <table class="memname">

  297.         <tr>

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

  299.           <td>(</td>

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

  301.           <td></td>

  302.         </tr>

  303.       </table>

  304.   </td>

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

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

  307.   </tr>

  308. </table>

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

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

  311. 

  312. </div>

  313. </div>

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

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

  316. 

  317. <div class="memitem">

  318. <div class="memproto">

  319. <table class="mlabels">

  320.   <tr>

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

  322.       <table class="memname">

  323.         <tr>

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

  325.           <td>(</td>

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

  327.           <td></td>

  328.         </tr>

  329.       </table>

  330.   </td>

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

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

  333.   </tr>

  334. </table>

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

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

  337. 

  338. </div>

  339. </div>

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

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

  342. 

  343. <div class="memitem">

  344. <div class="memproto">

  345. <table class="mlabels">

  346.   <tr>

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

  348.       <table class="memname">

  349.         <tr>

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

  351.           <td>(</td>

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

  353.           <td></td>

  354.         </tr>

  355.       </table>

  356.   </td>

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

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

  359.   </tr>

  360. </table>

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

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

  363. 

  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. 

  369. <div class="memitem">

  370. <div class="memproto">

  371. <table class="mlabels">

  372.   <tr>

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

  374.       <table class="memname">

  375.         <tr>

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

  377.           <td>(</td>

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

  379.           <td></td>

  380.         </tr>

  381.       </table>

  382.   </td>

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

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

  385.   </tr>

  386. </table>

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

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

  389. 

  390. </div>

  391. </div>

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

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

  394. 

  395. <div class="memitem">

  396. <div class="memproto">

  397. <table class="mlabels">

  398.   <tr>

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

  400.       <table class="memname">

  401.         <tr>

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

  403.           <td>(</td>

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

  405.           <td></td>

  406.         </tr>

  407.       </table>

  408.   </td>

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

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

  411.   </tr>

  412. </table>

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

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

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

  416. 

  417. </div>

  418. </div>

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

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

  421. 

  422. <div class="memitem">

  423. <div class="memproto">

  424. <table class="mlabels">

  425.   <tr>

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

  427.       <table class="memname">

  428.         <tr>

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

  430.           <td>(</td>

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

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

  433.         </tr>

  434.         <tr>

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

  436.           <td></td>

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

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

  439.         </tr>

  440.         <tr>

  441.           <td></td>

  442.           <td>)</td>

  443.           <td></td><td></td>

  444.         </tr>

  445.       </table>

  446.   </td>

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

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

  449.   </tr>

  450. </table>

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

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

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

  454.   <table class="params">

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

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

  457.   </table>

  458.   </dd>

  459. </dl>

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

  461. 

  462. </div>

  463. </div>

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

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

  466. 

  467. <div class="memitem">

  468. <div class="memproto">

  469. <table class="mlabels">

  470.   <tr>

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

  472.       <table class="memname">

  473.         <tr>

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

  475.           <td>(</td>

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

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

  478.         </tr>

  479.         <tr>

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

  481.           <td></td>

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

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

  484.         </tr>

  485.         <tr>

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

  487.           <td></td>

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

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

  490.         </tr>

  491.         <tr>

  492.           <td></td>

  493.           <td>)</td>

  494.           <td></td><td></td>

  495.         </tr>

  496.       </table>

  497.   </td>

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

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

  500.   </tr>

  501. </table>

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

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

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

  505.   <table class="params">

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

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

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

  509.   </table>

  510.   </dd>

  511. </dl>

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

  513. 

  514. </div>

  515. </div>

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

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

  518. 

  519. <div class="memitem">

  520. <div class="memproto">

  521. <table class="mlabels">

  522.   <tr>

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

  524.       <table class="memname">

  525.         <tr>

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

  527.           <td>(</td>

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

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

  530.         </tr>

  531.         <tr>

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

  533.           <td></td>

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

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

  536.         </tr>

  537.         <tr>

  538.           <td></td>

  539.           <td>)</td>

  540.           <td></td><td></td>

  541.         </tr>

  542.       </table>

  543.   </td>

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

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

  546.   </tr>

  547. </table>

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

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

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

  551.   <table class="params">

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

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

  554.   </table>

  555.   </dd>

  556. </dl>

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

  558. 

  559. </div>

  560. </div>

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

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

  563. 

  564. <div class="memitem">

  565. <div class="memproto">

  566. <table class="mlabels">

  567.   <tr>

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

  569.       <table class="memname">

  570.         <tr>

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

  572.           <td>(</td>

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

  574.           <td> const</td>

  575.         </tr>

  576.       </table>

  577.   </td>

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

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

  580.   </tr>

  581. </table>

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

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

  584. 

  585. </div>

  586. </div>

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

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

  589. 

  590. <div class="memitem">

  591. <div class="memproto">

  592. <table class="mlabels">

  593.   <tr>

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

  595.       <table class="memname">

  596.         <tr>

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

  598.           <td>(</td>

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

  600.           <td> const</td>

  601.         </tr>

  602.       </table>

  603.   </td>

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

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

  606.   </tr>

  607. </table>

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

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

  610. 

  611. </div>

  612. </div>

  613. <a id="a6858d18c807411a071fd6d1b39d50087"></a>

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

  615. 

  616. <div class="memitem">

  617. <div class="memproto">

  618. <table class="mlabels">

  619.   <tr>

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

  621.       <table class="memname">

  622.         <tr>

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

  624.           <td>(</td>

  625.           <td class="paramtype">dir_t *&#160;</td>

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

  627.           <td></td>

  628.         </tr>

  629.       </table>

  630.   </td>

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

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

  633.   </tr>

  634. </table>

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

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

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

  638.   <table class="params">

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

  640.   </table>

  641.   </dd>

  642. </dl>

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

  644. 

  645. </div>

  646. </div>

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

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

  649. 

  650. <div class="memitem">

  651. <div class="memproto">

  652. <table class="mlabels">

  653.   <tr>

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

  655.       <table class="memname">

  656.         <tr>

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

  658.           <td>(</td>

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

  660.           <td></td>

  661.         </tr>

  662.       </table>

  663.   </td>

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

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

  666.   </tr>

  667. </table>

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

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

  670. 

  671. </div>

  672. </div>

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

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

  675. 

  676. <div class="memitem">

  677. <div class="memproto">

  678. <table class="mlabels">

  679.   <tr>

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

  681.       <table class="memname">

  682.         <tr>

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

  684.           <td>(</td>

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

  686.           <td></td>

  687.         </tr>

  688.       </table>

  689.   </td>

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

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

  692.   </tr>

  693. </table>

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

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

  696. 

  697. </div>

  698. </div>

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

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

  701. 

  702. <div class="memitem">

  703. <div class="memproto">

  704. <table class="mlabels">

  705.   <tr>

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

  707.       <table class="memname">

  708.         <tr>

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

  710.           <td>(</td>

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

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

  713.         </tr>

  714.         <tr>

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

  716.           <td></td>

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

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

  719.         </tr>

  720.         <tr>

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

  722.           <td></td>

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

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

  725.         </tr>

  726.         <tr>

  727.           <td></td>

  728.           <td>)</td>

  729.           <td></td><td></td>

  730.         </tr>

  731.       </table>

  732.   </td>

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

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

  735.   </tr>

  736. </table>

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

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

  739.   <table class="params">

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

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

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

  743.   </table>

  744.   </dd>

  745. </dl>

  746. 

  747. </div>

  748. </div>

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

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

  751. 

  752. <div class="memitem">

  753. <div class="memproto">

  754. <table class="mlabels">

  755.   <tr>

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

  757.       <table class="memname">

  758.         <tr>

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

  760.           <td>(</td>

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

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

  763.           <td></td>

  764.         </tr>

  765.       </table>

  766.   </td>

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

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

  769.   </tr>

  770. </table>

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

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

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

  774.   <table class="params">

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

  776.   </table>

  777.   </dd>

  778. </dl>

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

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

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

  782. 

  783. </div>

  784. </div>

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

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

  787. 

  788. <div class="memitem">

  789. <div class="memproto">

  790. <table class="mlabels">

  791.   <tr>

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

  793.       <table class="memname">

  794.         <tr>

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

  796.           <td>(</td>

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

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

  799.           <td></td>

  800.         </tr>

  801.       </table>

  802.   </td>

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

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

  805.   </tr>

  806. </table>

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

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

  809.   <table class="params">

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

  811.   </table>

  812.   </dd>

  813. </dl>

  814. 

  815. </div>

  816. </div>

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

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

  819. 

  820. <div class="memitem">

  821. <div class="memproto">

  822. <table class="mlabels">

  823.   <tr>

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

  825.       <table class="memname">

  826.         <tr>

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

  828.           <td>(</td>

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

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

  831.         </tr>

  832.         <tr>

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

  834.           <td></td>

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

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

  837.         </tr>

  838.         <tr>

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

  840.           <td></td>

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

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

  843.         </tr>

  844.         <tr>

  845.           <td></td>

  846.           <td>)</td>

  847.           <td></td><td></td>

  848.         </tr>

  849.       </table>

  850.   </td>

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

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

  853.   </tr>

  854. </table>

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

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

  857. <p><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets()</a> reads bytes from a file into the array pointed to by <em>str</em>, until <em>num</em> - 1 bytes are read, or a delimiter is read and transferred to <em>str</em>, or end-of-file is encountered. The string is then terminated with a null byte.</p>

  858. <p><a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets()</a> deletes CR, '\r', from the string. This insures only a '\n' terminates the string for Windows text files which use CRLF for newline.</p>

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

  860.   <table class="params">

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

  862.     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>Maximum number of characters to be read (including the final null byte). Usually the length of the array <em>str</em> is used. </td></tr>

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

  864.   </table>

  865.   </dd>

  866. </dl>

  867. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets()</a> returns the length of the string in <em>str</em>. If no data is read, <a class="el" href="class_fat_file.html#a9e05a51767f7c8f70c6f337eecbdca03">fgets()</a> returns zero for EOF or -1 if an error occurred. </dd></dl>

  868. 

  869. </div>

  870. </div>

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

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

  873. 

  874. <div class="memitem">

  875. <div class="memproto">

  876. <table class="mlabels">

  877.   <tr>

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

  879.       <table class="memname">

  880.         <tr>

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

  882.           <td>(</td>

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

  884.           <td> const</td>

  885.         </tr>

  886.       </table>

  887.   </td>

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

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

  890.   </tr>

  891. </table>

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

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

  894. 

  895. </div>

  896. </div>

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

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

  899. 

  900. <div class="memitem">

  901. <div class="memproto">

  902. <table class="mlabels">

  903.   <tr>

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

  905.       <table class="memname">

  906.         <tr>

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

  908.           <td>(</td>

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

  910.           <td> const</td>

  911.         </tr>

  912.       </table>

  913.   </td>

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

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

  916.   </tr>

  917. </table>

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

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

  920. 

  921. </div>

  922. </div>

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

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

  925. 

  926. <div class="memitem">

  927. <div class="memproto">

  928. <table class="mlabels">

  929.   <tr>

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

  931.       <table class="memname">

  932.         <tr>

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

  934.           <td>(</td>

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

  936.           <td> const</td>

  937.         </tr>

  938.       </table>

  939.   </td>

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

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

  942.   </tr>

  943. </table>

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

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

  946. 

  947. </div>

  948. </div>

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

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

  951. 

  952. <div class="memitem">

  953. <div class="memproto">

  954. <table class="mlabels">

  955.   <tr>

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

  957.       <table class="memname">

  958.         <tr>

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

  960.           <td>(</td>

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

  962.           <td></td>

  963.         </tr>

  964.       </table>

  965.   </td>

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

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

  968.   </tr>

  969. </table>

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

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

  972. 

  973. </div>

  974. </div>

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

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

  977. 

  978. <div class="memitem">

  979. <div class="memproto">

  980. <table class="mlabels">

  981.   <tr>

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

  983.       <table class="memname">

  984.         <tr>

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

  986.           <td>(</td>

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

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

  989.           <td></td>

  990.         </tr>

  991.       </table>

  992.   </td>

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

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

  995.   </tr>

  996. </table>

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

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

  999.   <table class="params">

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

  1001.   </table>

  1002.   </dd>

  1003. </dl>

  1004. 

  1005. </div>

  1006. </div>

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

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

  1009. 

  1010. <div class="memitem">

  1011. <div class="memproto">

  1012. <table class="mlabels">

  1013.   <tr>

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

  1015.       <table class="memname">

  1016.         <tr>

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

  1018.           <td>(</td>

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

  1020.           <td></td>

  1021.         </tr>

  1022.       </table>

  1023.   </td>

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

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

  1026.   </tr>

  1027. </table>

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

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

  1030. 

  1031. </div>

  1032. </div>

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

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

  1035. 

  1036. <div class="memitem">

  1037. <div class="memproto">

  1038. <table class="mlabels">

  1039.   <tr>

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

  1041.       <table class="memname">

  1042.         <tr>

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

  1044.           <td>(</td>

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

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

  1047.         </tr>

  1048.         <tr>

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

  1050.           <td></td>

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

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

  1053.         </tr>

  1054.         <tr>

  1055.           <td></td>

  1056.           <td>)</td>

  1057.           <td></td><td></td>

  1058.         </tr>

  1059.       </table>

  1060.   </td>

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

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

  1063.   </tr>

  1064. </table>

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

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

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

  1068.   <table class="params">

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

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

  1071.   </table>

  1072.   </dd>

  1073. </dl>

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

  1075. 

  1076. </div>

  1077. </div>

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

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

  1080. 

  1081. <div class="memitem">

  1082. <div class="memproto">

  1083. <table class="mlabels">

  1084.   <tr>

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

  1086.       <table class="memname">

  1087.         <tr>

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

  1089.           <td>(</td>

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

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

  1092.           <td></td>

  1093.         </tr>

  1094.       </table>

  1095.   </td>

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

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

  1098.   </tr>

  1099. </table>

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

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

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

  1103.   <table class="params">

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

  1105.   </table>

  1106.   </dd>

  1107. </dl>

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

  1109. 

  1110. </div>

  1111. </div>

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

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

  1114. 

  1115. <div class="memitem">

  1116. <div class="memproto">

  1117. <table class="mlabels">

  1118.   <tr>

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

  1120.       <table class="memname">

  1121.         <tr>

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

  1123.           <td>(</td>

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

  1125.           <td></td>

  1126.         </tr>

  1127.       </table>

  1128.   </td>

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

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

  1131.   </tr>

  1132. </table>

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

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

  1135. 

  1136. </div>

  1137. </div>

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

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

  1140. 

  1141. <div class="memitem">

  1142. <div class="memproto">

  1143. <table class="mlabels">

  1144.   <tr>

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

  1146.       <table class="memname">

  1147.         <tr>

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

  1149.           <td>(</td>

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

  1151.           <td> const</td>

  1152.         </tr>

  1153.       </table>

  1154.   </td>

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

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

  1157.   </tr>

  1158. </table>

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

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

  1161. 

  1162. </div>

  1163. </div>

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

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

  1166. 

  1167. <div class="memitem">

  1168. <div class="memproto">

  1169. <table class="mlabels">

  1170.   <tr>

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

  1172.       <table class="memname">

  1173.         <tr>

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

  1175.           <td>(</td>

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

  1177.           <td></td>

  1178.         </tr>

  1179.       </table>

  1180.   </td>

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

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

  1183.   </tr>

  1184. </table>

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

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

  1187. 

  1188. </div>

  1189. </div>

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

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

  1192. 

  1193. <div class="memitem">

  1194. <div class="memproto">

  1195. <table class="mlabels">

  1196.   <tr>

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

  1198.       <table class="memname">

  1199.         <tr>

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

  1201.           <td>(</td>

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

  1203.           <td> const</td>

  1204.         </tr>

  1205.       </table>

  1206.   </td>

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

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

  1209.   </tr>

  1210. </table>

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

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

  1213. 

  1214. </div>

  1215. </div>

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

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

  1218. 

  1219. <div class="memitem">

  1220. <div class="memproto">

  1221. <table class="mlabels">

  1222.   <tr>

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

  1224.       <table class="memname">

  1225.         <tr>

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

  1227.           <td>(</td>

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

  1229.           <td> const</td>

  1230.         </tr>

  1231.       </table>

  1232.   </td>

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

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

  1235.   </tr>

  1236. </table>

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

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

  1239. 

  1240. </div>

  1241. </div>

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

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

  1244. 

  1245. <div class="memitem">

  1246. <div class="memproto">

  1247. <table class="mlabels">

  1248.   <tr>

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

  1250.       <table class="memname">

  1251.         <tr>

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

  1253.           <td>(</td>

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

  1255.           <td> const</td>

  1256.         </tr>

  1257.       </table>

  1258.   </td>

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

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

  1261.   </tr>

  1262. </table>

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

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

  1265. 

  1266. </div>

  1267. </div>

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

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

  1270. 

  1271. <div class="memitem">

  1272. <div class="memproto">

  1273. <table class="mlabels">

  1274.   <tr>

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

  1276.       <table class="memname">

  1277.         <tr>

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

  1279.           <td>(</td>

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

  1281.           <td> const</td>

  1282.         </tr>

  1283.       </table>

  1284.   </td>

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

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

  1287.   </tr>

  1288. </table>

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

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

  1291. 

  1292. </div>

  1293. </div>

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

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

  1296. 

  1297. <div class="memitem">

  1298. <div class="memproto">

  1299. <table class="mlabels">

  1300.   <tr>

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

  1302.       <table class="memname">

  1303.         <tr>

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

  1305.           <td>(</td>

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

  1307.           <td> const</td>

  1308.         </tr>

  1309.       </table>

  1310.   </td>

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

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

  1313.   </tr>

  1314. </table>

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

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

  1317. 

  1318. </div>

  1319. </div>

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

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

  1322. 

  1323. <div class="memitem">

  1324. <div class="memproto">

  1325. <table class="mlabels">

  1326.   <tr>

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

  1328.       <table class="memname">

  1329.         <tr>

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

  1331.           <td>(</td>

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

  1333.           <td> const</td>

  1334.         </tr>

  1335.       </table>

  1336.   </td>

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

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

  1339.   </tr>

  1340. </table>

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

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

  1343. 

  1344. </div>

  1345. </div>

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

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

  1348. 

  1349. <div class="memitem">

  1350. <div class="memproto">

  1351. <table class="mlabels">

  1352.   <tr>

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

  1354.       <table class="memname">

  1355.         <tr>

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

  1357.           <td>(</td>

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

  1359.           <td> const</td>

  1360.         </tr>

  1361.       </table>

  1362.   </td>

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

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

  1365.   </tr>

  1366. </table>

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

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

  1369. 

  1370. </div>

  1371. </div>

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

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

  1374. 

  1375. <div class="memitem">

  1376. <div class="memproto">

  1377. <table class="mlabels">

  1378.   <tr>

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

  1380.       <table class="memname">

  1381.         <tr>

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

  1383.           <td>(</td>

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

  1385.           <td> const</td>

  1386.         </tr>

  1387.       </table>

  1388.   </td>

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

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

  1391.   </tr>

  1392. </table>

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

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

  1395. 

  1396. </div>

  1397. </div>

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

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

  1400. 

  1401. <div class="memitem">

  1402. <div class="memproto">

  1403. <table class="mlabels">

  1404.   <tr>

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

  1406.       <table class="memname">

  1407.         <tr>

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

  1409.           <td>(</td>

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

  1411.           <td> const</td>

  1412.         </tr>

  1413.       </table>

  1414.   </td>

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

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

  1417.   </tr>

  1418. </table>

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

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

  1421. 

  1422. </div>

  1423. </div>

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

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

  1426. 

  1427. <div class="memitem">

  1428. <div class="memproto">

  1429. <table class="mlabels">

  1430.   <tr>

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

  1432.       <table class="memname">

  1433.         <tr>

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

  1435.           <td>(</td>

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

  1437.           <td> const</td>

  1438.         </tr>

  1439.       </table>

  1440.   </td>

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

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

  1443.   </tr>

  1444. </table>

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

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

  1447. 

  1448. </div>

  1449. </div>

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

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

  1452. 

  1453. <div class="memitem">

  1454. <div class="memproto">

  1455. <table class="mlabels">

  1456.   <tr>

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

  1458.       <table class="memname">

  1459.         <tr>

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

  1461.           <td>(</td>

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

  1463.           <td> const</td>

  1464.         </tr>

  1465.       </table>

  1466.   </td>

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

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

  1469.   </tr>

  1470. </table>

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

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

  1473. 

  1474. </div>

  1475. </div>

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

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

  1478. 

  1479. <div class="memitem">

  1480. <div class="memproto">

  1481. <table class="mlabels">

  1482.   <tr>

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

  1484.       <table class="memname">

  1485.         <tr>

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

  1487.           <td>(</td>

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

  1489.           <td> const</td>

  1490.         </tr>

  1491.       </table>

  1492.   </td>

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

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

  1495.   </tr>

  1496. </table>

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

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

  1499. 

  1500. </div>

  1501. </div>

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

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

  1504. 

  1505. <div class="memitem">

  1506. <div class="memproto">

  1507. <table class="mlabels">

  1508.   <tr>

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

  1510.       <table class="memname">

  1511.         <tr>

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

  1513.           <td>(</td>

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

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

  1516.           <td></td>

  1517.         </tr>

  1518.       </table>

  1519.   </td>

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

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

  1522.   </tr>

  1523. </table>

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

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

  1526.   <table class="params">

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

  1528.   </table>

  1529.   </dd>

  1530. </dl>

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

  1532. 

  1533. </div>

  1534. </div>

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

  1536. <h2 class="memtitle"><span class="permalink"><a href="#a60ab9d16bcc778150a364c26de467de1">&#9670;&nbsp;</a></span>ls()</h2>

  1537. 

  1538. <div class="memitem">

  1539. <div class="memproto">

  1540. <table class="mlabels">

  1541.   <tr>

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

  1543.       <table class="memname">

  1544.         <tr>

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

  1546.           <td>(</td>

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

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

  1549.         </tr>

  1550.         <tr>

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

  1552.           <td></td>

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

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

  1555.         </tr>

  1556.         <tr>

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

  1558.           <td></td>

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

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

  1561.         </tr>

  1562.         <tr>

  1563.           <td></td>

  1564.           <td>)</td>

  1565.           <td></td><td></td>

  1566.         </tr>

  1567.       </table>

  1568.   </td>

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

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

  1571.   </tr>

  1572. </table>

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

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

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

  1576.   <table class="params">

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

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

  1579.   </table>

  1580.   </dd>

  1581. </dl>

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

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

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

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

  1586.   <table class="params">

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

  1588.   </table>

  1589.   </dd>

  1590. </dl>

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

  1592. 

  1593. </div>

  1594. </div>

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

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

  1597. 

  1598. <div class="memitem">

  1599. <div class="memproto">

  1600. <table class="mlabels">

  1601.   <tr>

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

  1603.       <table class="memname">

  1604.         <tr>

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

  1606.           <td>(</td>

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

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

  1609.         </tr>

  1610.         <tr>

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

  1612.           <td></td>

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

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

  1615.         </tr>

  1616.         <tr>

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

  1618.           <td></td>

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

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

  1621.         </tr>

  1622.         <tr>

  1623.           <td></td>

  1624.           <td>)</td>

  1625.           <td></td><td></td>

  1626.         </tr>

  1627.       </table>

  1628.   </td>

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

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

  1631.   </tr>

  1632. </table>

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

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

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

  1636.   <table class="params">

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

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

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

  1640.   </table>

  1641.   </dd>

  1642. </dl>

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

  1644. 

  1645. </div>

  1646. </div>

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

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

  1649. 

  1650. <div class="memitem">

  1651. <div class="memproto">

  1652. <table class="mlabels">

  1653.   <tr>

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

  1655.       <table class="memname">

  1656.         <tr>

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

  1658.           <td>(</td>

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

  1660.           <td> const</td>

  1661.         </tr>

  1662.       </table>

  1663.   </td>

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

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

  1666.   </tr>

  1667. </table>

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

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

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

  1671. 

  1672. </div>

  1673. </div>

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

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

  1676. 

  1677. <div class="memitem">

  1678. <div class="memproto">

  1679. <table class="mlabels">

  1680.   <tr>

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

  1682.       <table class="memname">

  1683.         <tr>

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

  1685.           <td>(</td>

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

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

  1688.         </tr>

  1689.         <tr>

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

  1691.           <td></td>

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

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

  1694.         </tr>

  1695.         <tr>

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

  1697.           <td></td>

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

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

  1700.         </tr>

  1701.         <tr>

  1702.           <td></td>

  1703.           <td>)</td>

  1704.           <td></td><td></td>

  1705.         </tr>

  1706.       </table>

  1707.   </td>

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

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

  1710.   </tr>

  1711. </table>

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

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

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

  1715.   <table class="params">

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

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

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

  1719.   </table>

  1720.   </dd>

  1721. </dl>

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

  1723. 

  1724. </div>

  1725. </div>

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

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

  1728. 

  1729. <div class="memitem">

  1730. <div class="memproto">

  1731. <table class="mlabels">

  1732.   <tr>

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

  1734.       <table class="memname">

  1735.         <tr>

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

  1737.           <td>(</td>

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

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

  1740.         </tr>

  1741.         <tr>

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

  1743.           <td></td>

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

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

  1746.         </tr>

  1747.         <tr>

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

  1749.           <td></td>

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

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

  1752.         </tr>

  1753.         <tr>

  1754.           <td></td>

  1755.           <td>)</td>

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

  1757.         </tr>

  1758.       </table>

  1759.   </td>

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

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

  1762.   </tr>

  1763. </table>

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

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

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

  1767.   <table class="params">

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

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

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

  1771.   </table>

  1772.   </dd>

  1773. </dl>

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

  1775. 

  1776. </div>

  1777. </div>

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

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

  1780. 

  1781. <div class="memitem">

  1782. <div class="memproto">

  1783. <table class="mlabels">

  1784.   <tr>

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

  1786.       <table class="memname">

  1787.         <tr>

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

  1789.           <td>(</td>

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

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

  1792.         </tr>

  1793.         <tr>

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

  1795.           <td></td>

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

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

  1798.         </tr>

  1799.         <tr>

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

  1801.           <td></td>

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

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

  1804.         </tr>

  1805.         <tr>

  1806.           <td></td>

  1807.           <td>)</td>

  1808.           <td></td><td></td>

  1809.         </tr>

  1810.       </table>

  1811.   </td>

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

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

  1814.   </tr>

  1815. </table>

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

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

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

  1819.   <table class="params">

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

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

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

  1823.   </table>

  1824.   </dd>

  1825. </dl>

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

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

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

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

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

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

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

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

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

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

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

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

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

  1839. 

  1840. </div>

  1841. </div>

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

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

  1844. 

  1845. <div class="memitem">

  1846. <div class="memproto">

  1847. <table class="mlabels">

  1848.   <tr>

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

  1850.       <table class="memname">

  1851.         <tr>

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

  1853.           <td>(</td>

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

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

  1856.         </tr>

  1857.         <tr>

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

  1859.           <td></td>

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

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

  1862.         </tr>

  1863.         <tr>

  1864.           <td></td>

  1865.           <td>)</td>

  1866.           <td></td><td></td>

  1867.         </tr>

  1868.       </table>

  1869.   </td>

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

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

  1872.   </tr>

  1873. </table>

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

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

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

  1877.   <table class="params">

  1878.     <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>

  1879.     <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>

  1880.   </table>

  1881.   </dd>

  1882. </dl>

  1883. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1884. 

  1885. </div>

  1886. </div>

  1887. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>

  1888. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>

  1889. 

  1890. <div class="memitem">

  1891. <div class="memproto">

  1892. <table class="mlabels">

  1893.   <tr>

  1894.   <td class="mlabels-left">

  1895.       <table class="memname">

  1896.         <tr>

  1897.           <td class="memname">bool FatFile::openNext </td>

  1898.           <td>(</td>

  1899.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  1900.           <td class="paramname"><em>dirFile</em>, </td>

  1901.         </tr>

  1902.         <tr>

  1903.           <td class="paramkey"></td>

  1904.           <td></td>

  1905.           <td class="paramtype">oflag_t&#160;</td>

  1906.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  1907.         </tr>

  1908.         <tr>

  1909.           <td></td>

  1910.           <td>)</td>

  1911.           <td></td><td></td>

  1912.         </tr>

  1913.       </table>

  1914.   </td>

  1915.   <td class="mlabels-right">

  1916. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1917.   </tr>

  1918. </table>

  1919. </div><div class="memdoc">

  1920. <p>Open the next file or subdirectory in a directory.</p>

  1921. <dl class="params"><dt>Parameters</dt><dd>

  1922.   <table class="params">

  1923.     <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>

  1924.     <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>

  1925.   </table>

  1926.   </dd>

  1927. </dl>

  1928. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1929. 

  1930. </div>

  1931. </div>

  1932. <a id="a571434707124ee554d659ec82e2ef750"></a>

  1933. <h2 class="memtitle"><span class="permalink"><a href="#a571434707124ee554d659ec82e2ef750">&#9670;&nbsp;</a></span>openNextFile()</h2>

  1934. 

  1935. <div class="memitem">

  1936. <div class="memproto">

  1937. <table class="mlabels">

  1938.   <tr>

  1939.   <td class="mlabels-left">

  1940.       <table class="memname">

  1941.         <tr>

  1942.           <td class="memname"><a class="el" href="class_file32.html">File32</a> File32::openNextFile </td>

  1943.           <td>(</td>

  1944.           <td class="paramtype">oflag_t&#160;</td>

  1945.           <td class="paramname"><em>oflag</em> = <code>0X00</code></td><td>)</td>

  1946.           <td></td>

  1947.         </tr>

  1948.       </table>

  1949.   </td>

  1950.   <td class="mlabels-right">

  1951. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1952.   </tr>

  1953. </table>

  1954. </div><div class="memdoc">

  1955. <p>Opens the next file or folder in a directory.</p>

  1956. <dl class="params"><dt>Parameters</dt><dd>

  1957.   <table class="params">

  1958.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>

  1959.   </table>

  1960.   </dd>

  1961. </dl>

  1962. <dl class="section return"><dt>Returns</dt><dd>a FatStream object. </dd></dl>

  1963. 

  1964. </div>

  1965. </div>

  1966. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1967. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>

  1968. 

  1969. <div class="memitem">

  1970. <div class="memproto">

  1971. <table class="mlabels">

  1972.   <tr>

  1973.   <td class="mlabels-left">

  1974.       <table class="memname">

  1975.         <tr>

  1976.           <td class="memname">bool FatFile::openRoot </td>

  1977.           <td>(</td>

  1978.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  1979.           <td class="paramname"><em>vol</em></td><td>)</td>

  1980.           <td></td>

  1981.         </tr>

  1982.       </table>

  1983.   </td>

  1984.   <td class="mlabels-right">

  1985. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1986.   </tr>

  1987. </table>

  1988. </div><div class="memdoc">

  1989. <p>Open a volume's root directory.</p>

  1990. <dl class="params"><dt>Parameters</dt><dd>

  1991.   <table class="params">

  1992.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1993.   </table>

  1994.   </dd>

  1995. </dl>

  1996. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  1997. 

  1998. </div>

  1999. </div>

  2000. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>

  2001. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>

  2002. 

  2003. <div class="memitem">

  2004. <div class="memproto">

  2005. <table class="mlabels">

  2006.   <tr>

  2007.   <td class="mlabels-left">

  2008.       <table class="memname">

  2009.         <tr>

  2010.           <td class="memname">FatFile::operator bool </td>

  2011.           <td>(</td>

  2012.           <td class="paramname"></td><td>)</td>

  2013.           <td></td>

  2014.         </tr>

  2015.       </table>

  2016.   </td>

  2017.   <td class="mlabels-right">

  2018. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2019.   </tr>

  2020. </table>

  2021. </div><div class="memdoc">

  2022. <p>The parenthesis operator.</p>

  2023. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  2024. 

  2025. </div>

  2026. </div>

  2027. <a id="af0da96e502485133ca0cff27fa130082"></a>

  2028. <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">&#9670;&nbsp;</a></span>peek()</h2>

  2029. 

  2030. <div class="memitem">

  2031. <div class="memproto">

  2032. <table class="mlabels">

  2033.   <tr>

  2034.   <td class="mlabels-left">

  2035.       <table class="memname">

  2036.         <tr>

  2037.           <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>

  2038.           <td>(</td>

  2039.           <td class="paramname"></td><td>)</td>

  2040.           <td></td>

  2041.         </tr>

  2042.       </table>

  2043.   </td>

  2044.   <td class="mlabels-right">

  2045. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2046.   </tr>

  2047. </table>

  2048. </div><div class="memdoc">

  2049. <p>Return the next available byte without consuming it.</p>

  2050. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  2051. 

  2052. </div>

  2053. </div>

  2054. <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>

  2055. <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">&#9670;&nbsp;</a></span>position()</h2>

  2056. 

  2057. <div class="memitem">

  2058. <div class="memproto">

  2059. <table class="mlabels">

  2060.   <tr>

  2061.   <td class="mlabels-left">

  2062.       <table class="memname">

  2063.         <tr>

  2064.           <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>

  2065.           <td>(</td>

  2066.           <td class="paramname"></td><td>)</td>

  2067.           <td></td>

  2068.         </tr>

  2069.       </table>

  2070.   </td>

  2071.   <td class="mlabels-right">

  2072. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2073.   </tr>

  2074. </table>

  2075. </div><div class="memdoc">

  2076. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  2077. 

  2078. </div>

  2079. </div>

  2080. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>

  2081. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>

  2082. 

  2083. <div class="memitem">

  2084. <div class="memproto">

  2085. <table class="mlabels">

  2086.   <tr>

  2087.   <td class="mlabels-left">

  2088.       <table class="memname">

  2089.         <tr>

  2090.           <td class="memname">bool FatFile::preAllocate </td>

  2091.           <td>(</td>

  2092.           <td class="paramtype">uint32_t&#160;</td>

  2093.           <td class="paramname"><em>length</em></td><td>)</td>

  2094.           <td></td>

  2095.         </tr>

  2096.       </table>

  2097.   </td>

  2098.   <td class="mlabels-right">

  2099. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2100.   </tr>

  2101. </table>

  2102. </div><div class="memdoc">

  2103. <p>Allocate contiguous clusters to an empty file.</p>

  2104. <p>The file must be empty with no clusters allocated.</p>

  2105. <p>The file will contain uninitialized data.</p>

  2106. <dl class="params"><dt>Parameters</dt><dd>

  2107.   <table class="params">

  2108.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  2109.   </table>

  2110.   </dd>

  2111. </dl>

  2112. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2113. 

  2114. </div>

  2115. </div>

  2116. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>

  2117. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>

  2118. 

  2119. <div class="memitem">

  2120. <div class="memproto">

  2121. <table class="mlabels">

  2122.   <tr>

  2123.   <td class="mlabels-left">

  2124.       <table class="memname">

  2125.         <tr>

  2126.           <td class="memname">size_t FatFile::printAccessDate </td>

  2127.           <td>(</td>

  2128.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2129.           <td class="paramname"><em>pr</em></td><td>)</td>

  2130.           <td></td>

  2131.         </tr>

  2132.       </table>

  2133.   </td>

  2134.   <td class="mlabels-right">

  2135. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2136.   </tr>

  2137. </table>

  2138. </div><div class="memdoc">

  2139. <p>Print a file's access date</p>

  2140. <dl class="params"><dt>Parameters</dt><dd>

  2141.   <table class="params">

  2142.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2143.   </table>

  2144.   </dd>

  2145. </dl>

  2146. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2147. 

  2148. </div>

  2149. </div>

  2150. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>

  2151. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>

  2152. 

  2153. <div class="memitem">

  2154. <div class="memproto">

  2155. <table class="mlabels">

  2156.   <tr>

  2157.   <td class="mlabels-left">

  2158.       <table class="memname">

  2159.         <tr>

  2160.           <td class="memname">size_t FatFile::printAccessDateTime </td>

  2161.           <td>(</td>

  2162.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2163.           <td class="paramname"><em>pr</em></td><td>)</td>

  2164.           <td></td>

  2165.         </tr>

  2166.       </table>

  2167.   </td>

  2168.   <td class="mlabels-right">

  2169. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2170.   </tr>

  2171. </table>

  2172. </div><div class="memdoc">

  2173. <p>Print a file's access date</p>

  2174. <dl class="params"><dt>Parameters</dt><dd>

  2175.   <table class="params">

  2176.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2177.   </table>

  2178.   </dd>

  2179. </dl>

  2180. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2181. 

  2182. </div>

  2183. </div>

  2184. <a id="ab22396a285e27b53501a0047ddd97f59"></a>

  2185. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  2186. 

  2187. <div class="memitem">

  2188. <div class="memproto">

  2189. <table class="mlabels">

  2190.   <tr>

  2191.   <td class="mlabels-left">

  2192.       <table class="memname">

  2193.         <tr>

  2194.           <td class="memname">size_t FatFile::printCreateDateTime </td>

  2195.           <td>(</td>

  2196.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2197.           <td class="paramname"><em>pr</em></td><td>)</td>

  2198.           <td></td>

  2199.         </tr>

  2200.       </table>

  2201.   </td>

  2202.   <td class="mlabels-right">

  2203. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2204.   </tr>

  2205. </table>

  2206. </div><div class="memdoc">

  2207. <p>Print a file's creation date and time</p>

  2208. <dl class="params"><dt>Parameters</dt><dd>

  2209.   <table class="params">

  2210.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2211.   </table>

  2212.   </dd>

  2213. </dl>

  2214. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  2215. 

  2216. </div>

  2217. </div>

  2218. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>

  2219. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>

  2220. 

  2221. <div class="memitem">

  2222. <div class="memproto">

  2223. <table class="mlabels">

  2224.   <tr>

  2225.   <td class="mlabels-left">

  2226.       <table class="memname">

  2227.         <tr>

  2228.           <td class="memname">static void FatFile::printFatDate </td>

  2229.           <td>(</td>

  2230.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2231.           <td class="paramname"><em>pr</em>, </td>

  2232.         </tr>

  2233.         <tr>

  2234.           <td class="paramkey"></td>

  2235.           <td></td>

  2236.           <td class="paramtype">uint16_t&#160;</td>

  2237.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2238.         </tr>

  2239.         <tr>

  2240.           <td></td>

  2241.           <td>)</td>

  2242.           <td></td><td></td>

  2243.         </tr>

  2244.       </table>

  2245.   </td>

  2246.   <td class="mlabels-right">

  2247. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2248.   </tr>

  2249. </table>

  2250. </div><div class="memdoc">

  2251. <p>Print a directory date field.</p>

  2252. <p>Format is yyyy-mm-dd.</p>

  2253. <dl class="params"><dt>Parameters</dt><dd>

  2254.   <table class="params">

  2255.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2256.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2257.   </table>

  2258.   </dd>

  2259. </dl>

  2260. 

  2261. </div>

  2262. </div>

  2263. <a id="a7f84d953190ea94710dad9ebb897b957"></a>

  2264. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>

  2265. 

  2266. <div class="memitem">

  2267. <div class="memproto">

  2268. <table class="mlabels">

  2269.   <tr>

  2270.   <td class="mlabels-left">

  2271.       <table class="memname">

  2272.         <tr>

  2273.           <td class="memname">static void FatFile::printFatTime </td>

  2274.           <td>(</td>

  2275.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2276.           <td class="paramname"><em>pr</em>, </td>

  2277.         </tr>

  2278.         <tr>

  2279.           <td class="paramkey"></td>

  2280.           <td></td>

  2281.           <td class="paramtype">uint16_t&#160;</td>

  2282.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2283.         </tr>

  2284.         <tr>

  2285.           <td></td>

  2286.           <td>)</td>

  2287.           <td></td><td></td>

  2288.         </tr>

  2289.       </table>

  2290.   </td>

  2291.   <td class="mlabels-right">

  2292. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2293.   </tr>

  2294. </table>

  2295. </div><div class="memdoc">

  2296. <p>Print a directory time field.</p>

  2297. <p>Format is hh:mm:ss.</p>

  2298. <dl class="params"><dt>Parameters</dt><dd>

  2299.   <table class="params">

  2300.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2301.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2302.   </table>

  2303.   </dd>

  2304. </dl>

  2305. 

  2306. </div>

  2307. </div>

  2308. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>

  2309. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  2310. 

  2311. <div class="memitem">

  2312. <div class="memproto">

  2313. <table class="mlabels">

  2314.   <tr>

  2315.   <td class="mlabels-left">

  2316.       <table class="memname">

  2317.         <tr>

  2318.           <td class="memname">size_t FatFile::printField </td>

  2319.           <td>(</td>

  2320.           <td class="paramtype">double&#160;</td>

  2321.           <td class="paramname"><em>value</em>, </td>

  2322.         </tr>

  2323.         <tr>

  2324.           <td class="paramkey"></td>

  2325.           <td></td>

  2326.           <td class="paramtype">char&#160;</td>

  2327.           <td class="paramname"><em>term</em>, </td>

  2328.         </tr>

  2329.         <tr>

  2330.           <td class="paramkey"></td>

  2331.           <td></td>

  2332.           <td class="paramtype">uint8_t&#160;</td>

  2333.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2334.         </tr>

  2335.         <tr>

  2336.           <td></td>

  2337.           <td>)</td>

  2338.           <td></td><td></td>

  2339.         </tr>

  2340.       </table>

  2341.   </td>

  2342.   <td class="mlabels-right">

  2343. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2344.   </tr>

  2345. </table>

  2346. </div><div class="memdoc">

  2347. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2348.   <table class="params">

  2349.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2350.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2351.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2352.   </table>

  2353.   </dd>

  2354. </dl>

  2355. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2356. 

  2357. </div>

  2358. </div>

  2359. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>

  2360. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  2361. 

  2362. <div class="memitem">

  2363. <div class="memproto">

  2364. <table class="mlabels">

  2365.   <tr>

  2366.   <td class="mlabels-left">

  2367.       <table class="memname">

  2368.         <tr>

  2369.           <td class="memname">size_t FatFile::printField </td>

  2370.           <td>(</td>

  2371.           <td class="paramtype">float&#160;</td>

  2372.           <td class="paramname"><em>value</em>, </td>

  2373.         </tr>

  2374.         <tr>

  2375.           <td class="paramkey"></td>

  2376.           <td></td>

  2377.           <td class="paramtype">char&#160;</td>

  2378.           <td class="paramname"><em>term</em>, </td>

  2379.         </tr>

  2380.         <tr>

  2381.           <td class="paramkey"></td>

  2382.           <td></td>

  2383.           <td class="paramtype">uint8_t&#160;</td>

  2384.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2385.         </tr>

  2386.         <tr>

  2387.           <td></td>

  2388.           <td>)</td>

  2389.           <td></td><td></td>

  2390.         </tr>

  2391.       </table>

  2392.   </td>

  2393.   <td class="mlabels-right">

  2394. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2395.   </tr>

  2396. </table>

  2397. </div><div class="memdoc">

  2398. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2399.   <table class="params">

  2400.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2401.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2402.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2403.   </table>

  2404.   </dd>

  2405. </dl>

  2406. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2407. 

  2408. </div>

  2409. </div>

  2410. <a id="a8f906be79086f38943cb0911310d67bf"></a>

  2411. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  2412. 

  2413. <div class="memitem">

  2414. <div class="memproto">

  2415. <div class="memtemplate">

  2416. template&lt;typename Type &gt; </div>

  2417. <table class="mlabels">

  2418.   <tr>

  2419.   <td class="mlabels-left">

  2420.       <table class="memname">

  2421.         <tr>

  2422.           <td class="memname">size_t FatFile::printField </td>

  2423.           <td>(</td>

  2424.           <td class="paramtype">Type&#160;</td>

  2425.           <td class="paramname"><em>value</em>, </td>

  2426.         </tr>

  2427.         <tr>

  2428.           <td class="paramkey"></td>

  2429.           <td></td>

  2430.           <td class="paramtype">char&#160;</td>

  2431.           <td class="paramname"><em>term</em>&#160;</td>

  2432.         </tr>

  2433.         <tr>

  2434.           <td></td>

  2435.           <td>)</td>

  2436.           <td></td><td></td>

  2437.         </tr>

  2438.       </table>

  2439.   </td>

  2440.   <td class="mlabels-right">

  2441. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2442.   </tr>

  2443. </table>

  2444. </div><div class="memdoc">

  2445. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2446.   <table class="params">

  2447.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2448.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2449.   </table>

  2450.   </dd>

  2451. </dl>

  2452. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2453. 

  2454. </div>

  2455. </div>

  2456. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2457. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>

  2458. 

  2459. <div class="memitem">

  2460. <div class="memproto">

  2461. <table class="mlabels">

  2462.   <tr>

  2463.   <td class="mlabels-left">

  2464.       <table class="memname">

  2465.         <tr>

  2466.           <td class="memname">size_t FatFile::printFileSize </td>

  2467.           <td>(</td>

  2468.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2469.           <td class="paramname"><em>pr</em></td><td>)</td>

  2470.           <td></td>

  2471.         </tr>

  2472.       </table>

  2473.   </td>

  2474.   <td class="mlabels-right">

  2475. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2476.   </tr>

  2477. </table>

  2478. </div><div class="memdoc">

  2479. <p>Print a file's size.</p>

  2480. <dl class="params"><dt>Parameters</dt><dd>

  2481.   <table class="params">

  2482.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2483.   </table>

  2484.   </dd>

  2485. </dl>

  2486. <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>

  2487. 

  2488. </div>

  2489. </div>

  2490. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>

  2491. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>

  2492. 

  2493. <div class="memitem">

  2494. <div class="memproto">

  2495. <table class="mlabels">

  2496.   <tr>

  2497.   <td class="mlabels-left">

  2498.       <table class="memname">

  2499.         <tr>

  2500.           <td class="memname">size_t FatFile::printModifyDateTime </td>

  2501.           <td>(</td>

  2502.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2503.           <td class="paramname"><em>pr</em></td><td>)</td>

  2504.           <td></td>

  2505.         </tr>

  2506.       </table>

  2507.   </td>

  2508.   <td class="mlabels-right">

  2509. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2510.   </tr>

  2511. </table>

  2512. </div><div class="memdoc">

  2513. <p>Print a file's modify date and time</p>

  2514. <dl class="params"><dt>Parameters</dt><dd>

  2515.   <table class="params">

  2516.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2517.   </table>

  2518.   </dd>

  2519. </dl>

  2520. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2521. 

  2522. </div>

  2523. </div>

  2524. <a id="afe18a787fb8640e2d2483370c770f82f"></a>

  2525. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName()</h2>

  2526. 

  2527. <div class="memitem">

  2528. <div class="memproto">

  2529. <table class="mlabels">

  2530.   <tr>

  2531.   <td class="mlabels-left">

  2532.       <table class="memname">

  2533.         <tr>

  2534.           <td class="memname">size_t FatFile::printName </td>

  2535.           <td>(</td>

  2536.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2537.           <td class="paramname"><em>pr</em></td><td>)</td>

  2538.           <td></td>

  2539.         </tr>

  2540.       </table>

  2541.   </td>

  2542.   <td class="mlabels-right">

  2543. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2544.   </tr>

  2545. </table>

  2546. </div><div class="memdoc">

  2547. <p>Print a file's name</p>

  2548. <dl class="params"><dt>Parameters</dt><dd>

  2549.   <table class="params">

  2550.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2551.   </table>

  2552.   </dd>

  2553. </dl>

  2554. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2555. 

  2556. </div>

  2557. </div>

  2558. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2559. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>

  2560. 

  2561. <div class="memitem">

  2562. <div class="memproto">

  2563. <table class="mlabels">

  2564.   <tr>

  2565.   <td class="mlabels-left">

  2566.       <table class="memname">

  2567.         <tr>

  2568.           <td class="memname">size_t FatFile::printSFN </td>

  2569.           <td>(</td>

  2570.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2571.           <td class="paramname"><em>pr</em></td><td>)</td>

  2572.           <td></td>

  2573.         </tr>

  2574.       </table>

  2575.   </td>

  2576.   <td class="mlabels-right">

  2577. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2578.   </tr>

  2579. </table>

  2580. </div><div class="memdoc">

  2581. <p>Print a file's Short File Name.</p>

  2582. <dl class="params"><dt>Parameters</dt><dd>

  2583.   <table class="params">

  2584.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2585.   </table>

  2586.   </dd>

  2587. </dl>

  2588. <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>

  2589. 

  2590. </div>

  2591. </div>

  2592. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>

  2593. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  2594. 

  2595. <div class="memitem">

  2596. <div class="memproto">

  2597. <table class="mlabels">

  2598.   <tr>

  2599.   <td class="mlabels-left">

  2600.       <table class="memname">

  2601.         <tr>

  2602.           <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>

  2603.           <td>(</td>

  2604.           <td class="paramname"></td><td>)</td>

  2605.           <td></td>

  2606.         </tr>

  2607.       </table>

  2608.   </td>

  2609.   <td class="mlabels-right">

  2610. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2611.   </tr>

  2612. </table>

  2613. </div><div class="memdoc">

  2614. <p>Read the next byte from a file.</p>

  2615. <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>

  2616. 

  2617. </div>

  2618. </div>

  2619. <a id="aba893af8107a18017482d2311b066187"></a>

  2620. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2621. 

  2622. <div class="memitem">

  2623. <div class="memproto">

  2624. <table class="mlabels">

  2625.   <tr>

  2626.   <td class="mlabels-left">

  2627.       <table class="memname">

  2628.         <tr>

  2629.           <td class="memname">int FatFile::read </td>

  2630.           <td>(</td>

  2631.           <td class="paramtype">void *&#160;</td>

  2632.           <td class="paramname"><em>buf</em>, </td>

  2633.         </tr>

  2634.         <tr>

  2635.           <td class="paramkey"></td>

  2636.           <td></td>

  2637.           <td class="paramtype">size_t&#160;</td>

  2638.           <td class="paramname"><em>count</em>&#160;</td>

  2639.         </tr>

  2640.         <tr>

  2641.           <td></td>

  2642.           <td>)</td>

  2643.           <td></td><td></td>

  2644.         </tr>

  2645.       </table>

  2646.   </td>

  2647.   <td class="mlabels-right">

  2648. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2649.   </tr>

  2650. </table>

  2651. </div><div class="memdoc">

  2652. <p>Read data from a file starting at the current position.</p>

  2653. <dl class="params"><dt>Parameters</dt><dd>

  2654.   <table class="params">

  2655.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2656.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2657.   </table>

  2658.   </dd>

  2659. </dl>

  2660. <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>

  2661. 

  2662. </div>

  2663. </div>

  2664. <a id="a1325afe074c3efecff666678cd9f116a"></a>

  2665. <h2 class="memtitle"><span class="permalink"><a href="#a1325afe074c3efecff666678cd9f116a">&#9670;&nbsp;</a></span>readDir()</h2>

  2666. 

  2667. <div class="memitem">

  2668. <div class="memproto">

  2669. <table class="mlabels">

  2670.   <tr>

  2671.   <td class="mlabels-left">

  2672.       <table class="memname">

  2673.         <tr>

  2674.           <td class="memname">int8_t FatFile::readDir </td>

  2675.           <td>(</td>

  2676.           <td class="paramtype">dir_t *&#160;</td>

  2677.           <td class="paramname"><em>dir</em></td><td>)</td>

  2678.           <td></td>

  2679.         </tr>

  2680.       </table>

  2681.   </td>

  2682.   <td class="mlabels-right">

  2683. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2684.   </tr>

  2685. </table>

  2686. </div><div class="memdoc">

  2687. <p>Read the next directory entry from a directory file.</p>

  2688. <dl class="params"><dt>Parameters</dt><dd>

  2689.   <table class="params">

  2690.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2691.   </table>

  2692.   </dd>

  2693. </dl>

  2694. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">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#a1325afe074c3efecff666678cd9f116a">readDir()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> called before a directory has been opened, this is not a directory file or an I/O error occurred. </dd></dl>

  2695. 

  2696. </div>

  2697. </div>

  2698. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2699. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2700. 

  2701. <div class="memitem">

  2702. <div class="memproto">

  2703. <table class="mlabels">

  2704.   <tr>

  2705.   <td class="mlabels-left">

  2706.       <table class="memname">

  2707.         <tr>

  2708.           <td class="memname">bool FatFile::remove </td>

  2709.           <td>(</td>

  2710.           <td class="paramname"></td><td>)</td>

  2711.           <td></td>

  2712.         </tr>

  2713.       </table>

  2714.   </td>

  2715.   <td class="mlabels-right">

  2716. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2717.   </tr>

  2718. </table>

  2719. </div><div class="memdoc">

  2720. <p>Remove a file.</p>

  2721. <p>The directory entry and all data for the file are deleted.</p>

  2722. <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>

  2723. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2724. 

  2725. </div>

  2726. </div>

  2727. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>

  2728. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2729. 

  2730. <div class="memitem">

  2731. <div class="memproto">

  2732. <table class="mlabels">

  2733.   <tr>

  2734.   <td class="mlabels-left">

  2735.       <table class="memname">

  2736.         <tr>

  2737.           <td class="memname">bool FatFile::remove </td>

  2738.           <td>(</td>

  2739.           <td class="paramtype">const char *&#160;</td>

  2740.           <td class="paramname"><em>path</em></td><td>)</td>

  2741.           <td></td>

  2742.         </tr>

  2743.       </table>

  2744.   </td>

  2745.   <td class="mlabels-right">

  2746. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2747.   </tr>

  2748. </table>

  2749. </div><div class="memdoc">

  2750. <p>Remove a file.</p>

  2751. <p>The directory entry and all data for the file are deleted.</p>

  2752. <dl class="params"><dt>Parameters</dt><dd>

  2753.   <table class="params">

  2754.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2755.   </table>

  2756.   </dd>

  2757. </dl>

  2758. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2759. <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>

  2760. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2761. 

  2762. </div>

  2763. </div>

  2764. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>

  2765. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2766. 

  2767. <div class="memitem">

  2768. <div class="memproto">

  2769. <table class="mlabels">

  2770.   <tr>

  2771.   <td class="mlabels-left">

  2772.       <table class="memname">

  2773.         <tr>

  2774.           <td class="memname">bool FatFile::rename </td>

  2775.           <td>(</td>

  2776.           <td class="paramtype">const char *&#160;</td>

  2777.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2778.           <td></td>

  2779.         </tr>

  2780.       </table>

  2781.   </td>

  2782.   <td class="mlabels-right">

  2783. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2784.   </tr>

  2785. </table>

  2786. </div><div class="memdoc">

  2787. <p>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>

  2788. <dl class="params"><dt>Parameters</dt><dd>

  2789.   <table class="params">

  2790.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2791.   </table>

  2792.   </dd>

  2793. </dl>

  2794. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2795. 

  2796. </div>

  2797. </div>

  2798. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2799. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2800. 

  2801. <div class="memitem">

  2802. <div class="memproto">

  2803. <table class="mlabels">

  2804.   <tr>

  2805.   <td class="mlabels-left">

  2806.       <table class="memname">

  2807.         <tr>

  2808.           <td class="memname">bool FatFile::rename </td>

  2809.           <td>(</td>

  2810.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2811.           <td class="paramname"><em>dirFile</em>, </td>

  2812.         </tr>

  2813.         <tr>

  2814.           <td class="paramkey"></td>

  2815.           <td></td>

  2816.           <td class="paramtype">const char *&#160;</td>

  2817.           <td class="paramname"><em>newPath</em>&#160;</td>

  2818.         </tr>

  2819.         <tr>

  2820.           <td></td>

  2821.           <td>)</td>

  2822.           <td></td><td></td>

  2823.         </tr>

  2824.       </table>

  2825.   </td>

  2826.   <td class="mlabels-right">

  2827. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2828.   </tr>

  2829. </table>

  2830. </div><div class="memdoc">

  2831. <p>Rename a file or subdirectory.</p>

  2832. <dl class="params"><dt>Parameters</dt><dd>

  2833.   <table class="params">

  2834.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2835.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2836.   </table>

  2837.   </dd>

  2838. </dl>

  2839. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2840. 

  2841. </div>

  2842. </div>

  2843. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2844. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>

  2845. 

  2846. <div class="memitem">

  2847. <div class="memproto">

  2848. <table class="mlabels">

  2849.   <tr>

  2850.   <td class="mlabels-left">

  2851.       <table class="memname">

  2852.         <tr>

  2853.           <td class="memname">void FatFile::rewind </td>

  2854.           <td>(</td>

  2855.           <td class="paramname"></td><td>)</td>

  2856.           <td></td>

  2857.         </tr>

  2858.       </table>

  2859.   </td>

  2860.   <td class="mlabels-right">

  2861. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2862.   </tr>

  2863. </table>

  2864. </div><div class="memdoc">

  2865. <p>Set the file's current position to zero. </p>

  2866. 

  2867. </div>

  2868. </div>

  2869. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  2870. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  2871. 

  2872. <div class="memitem">

  2873. <div class="memproto">

  2874. <table class="mlabels">

  2875.   <tr>

  2876.   <td class="mlabels-left">

  2877.       <table class="memname">

  2878.         <tr>

  2879.           <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>

  2880.           <td>(</td>

  2881.           <td class="paramname"></td><td>)</td>

  2882.           <td></td>

  2883.         </tr>

  2884.       </table>

  2885.   </td>

  2886.   <td class="mlabels-right">

  2887. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2888.   </tr>

  2889. </table>

  2890. </div><div class="memdoc">

  2891. <p>Rewind a file if it is a directory </p>

  2892. 

  2893. </div>

  2894. </div>

  2895. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2896. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>

  2897. 

  2898. <div class="memitem">

  2899. <div class="memproto">

  2900. <table class="mlabels">

  2901.   <tr>

  2902.   <td class="mlabels-left">

  2903.       <table class="memname">

  2904.         <tr>

  2905.           <td class="memname">bool FatFile::rmdir </td>

  2906.           <td>(</td>

  2907.           <td class="paramname"></td><td>)</td>

  2908.           <td></td>

  2909.         </tr>

  2910.       </table>

  2911.   </td>

  2912.   <td class="mlabels-right">

  2913. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2914.   </tr>

  2915. </table>

  2916. </div><div class="memdoc">

  2917. <p>Remove a directory file.</p>

  2918. <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>

  2919. <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>

  2920. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2921. 

  2922. </div>

  2923. </div>

  2924. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2925. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>

  2926. 

  2927. <div class="memitem">

  2928. <div class="memproto">

  2929. <table class="mlabels">

  2930.   <tr>

  2931.   <td class="mlabels-left">

  2932.       <table class="memname">

  2933.         <tr>

  2934.           <td class="memname">bool FatFile::rmRfStar </td>

  2935.           <td>(</td>

  2936.           <td class="paramname"></td><td>)</td>

  2937.           <td></td>

  2938.         </tr>

  2939.       </table>

  2940.   </td>

  2941.   <td class="mlabels-right">

  2942. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2943.   </tr>

  2944. </table>

  2945. </div><div class="memdoc">

  2946. <p>Recursively delete a directory and all contained files.</p>

  2947. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2948. <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>

  2949. <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>

  2950. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2951. 

  2952. </div>

  2953. </div>

  2954. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  2955. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  2956. 

  2957. <div class="memitem">

  2958. <div class="memproto">

  2959. <table class="mlabels">

  2960.   <tr>

  2961.   <td class="mlabels-left">

  2962.       <table class="memname">

  2963.         <tr>

  2964.           <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>

  2965.           <td>(</td>

  2966.           <td class="paramtype">uint32_t&#160;</td>

  2967.           <td class="paramname"><em>pos</em></td><td>)</td>

  2968.           <td></td>

  2969.         </tr>

  2970.       </table>

  2971.   </td>

  2972.   <td class="mlabels-right">

  2973. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2974.   </tr>

  2975. </table>

  2976. </div><div class="memdoc">

  2977. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  2978. <dl class="params"><dt>Parameters</dt><dd>

  2979.   <table class="params">

  2980.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  2981.   </table>

  2982.   </dd>

  2983. </dl>

  2984. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2985. 

  2986. </div>

  2987. </div>

  2988. <a id="a5812037ea30777cc350698ad26f2c73f"></a>

  2989. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>

  2990. 

  2991. <div class="memitem">

  2992. <div class="memproto">

  2993. <table class="mlabels">

  2994.   <tr>

  2995.   <td class="mlabels-left">

  2996.       <table class="memname">

  2997.         <tr>

  2998.           <td class="memname">bool FatFile::seekCur </td>

  2999.           <td>(</td>

  3000.           <td class="paramtype">int32_t&#160;</td>

  3001.           <td class="paramname"><em>offset</em></td><td>)</td>

  3002.           <td></td>

  3003.         </tr>

  3004.       </table>

  3005.   </td>

  3006.   <td class="mlabels-right">

  3007. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3008.   </tr>

  3009. </table>

  3010. </div><div class="memdoc">

  3011. <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>

  3012.   <table class="params">

  3013.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  3014.   </table>

  3015.   </dd>

  3016. </dl>

  3017. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3018. 

  3019. </div>

  3020. </div>

  3021. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  3022. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>

  3023. 

  3024. <div class="memitem">

  3025. <div class="memproto">

  3026. <table class="mlabels">

  3027.   <tr>

  3028.   <td class="mlabels-left">

  3029.       <table class="memname">

  3030.         <tr>

  3031.           <td class="memname">bool FatFile::seekEnd </td>

  3032.           <td>(</td>

  3033.           <td class="paramtype">int32_t&#160;</td>

  3034.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  3035.           <td></td>

  3036.         </tr>

  3037.       </table>

  3038.   </td>

  3039.   <td class="mlabels-right">

  3040. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3041.   </tr>

  3042. </table>

  3043. </div><div class="memdoc">

  3044. <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>

  3045.   <table class="params">

  3046.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  3047.   </table>

  3048.   </dd>

  3049. </dl>

  3050. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3051. 

  3052. </div>

  3053. </div>

  3054. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>

  3055. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>

  3056. 

  3057. <div class="memitem">

  3058. <div class="memproto">

  3059. <table class="mlabels">

  3060.   <tr>

  3061.   <td class="mlabels-left">

  3062.       <table class="memname">

  3063.         <tr>

  3064.           <td class="memname">bool FatFile::seekSet </td>

  3065.           <td>(</td>

  3066.           <td class="paramtype">uint32_t&#160;</td>

  3067.           <td class="paramname"><em>pos</em></td><td>)</td>

  3068.           <td></td>

  3069.         </tr>

  3070.       </table>

  3071.   </td>

  3072.   <td class="mlabels-right">

  3073. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3074.   </tr>

  3075. </table>

  3076. </div><div class="memdoc">

  3077. <p>Sets a file's position.</p>

  3078. <dl class="params"><dt>Parameters</dt><dd>

  3079.   <table class="params">

  3080.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>The new position in bytes from the beginning of the file.</td></tr>

  3081.   </table>

  3082.   </dd>

  3083. </dl>

  3084. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3085. 

  3086. </div>

  3087. </div>

  3088. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  3089. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  3090. 

  3091. <div class="memitem">

  3092. <div class="memproto">

  3093. <table class="mlabels">

  3094.   <tr>

  3095.   <td class="mlabels-left">

  3096.       <table class="memname">

  3097.         <tr>

  3098.           <td class="memname">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>

  3099.           <td>(</td>

  3100.           <td class="paramname"></td><td>)</td>

  3101.           <td></td>

  3102.         </tr>

  3103.       </table>

  3104.   </td>

  3105.   <td class="mlabels-right">

  3106. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3107.   </tr>

  3108. </table>

  3109. </div><div class="memdoc">

  3110. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  3111. 

  3112. </div>

  3113. </div>

  3114. <a id="a67f3dc4896c542d695e11aac927f585e"></a>

  3115. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>

  3116. 

  3117. <div class="memitem">

  3118. <div class="memproto">

  3119. <table class="mlabels">

  3120.   <tr>

  3121.   <td class="mlabels-left">

  3122.       <table class="memname">

  3123.         <tr>

  3124.           <td class="memname">bool FatFile::sync </td>

  3125.           <td>(</td>

  3126.           <td class="paramname"></td><td>)</td>

  3127.           <td></td>

  3128.         </tr>

  3129.       </table>

  3130.   </td>

  3131.   <td class="mlabels-right">

  3132. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3133.   </tr>

  3134. </table>

  3135. </div><div class="memdoc">

  3136. <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>

  3137. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3138. 

  3139. </div>

  3140. </div>

  3141. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3142. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>

  3143. 

  3144. <div class="memitem">

  3145. <div class="memproto">

  3146. <table class="mlabels">

  3147.   <tr>

  3148.   <td class="mlabels-left">

  3149.       <table class="memname">

  3150.         <tr>

  3151.           <td class="memname">bool FatFile::timestamp </td>

  3152.           <td>(</td>

  3153.           <td class="paramtype">uint8_t&#160;</td>

  3154.           <td class="paramname"><em>flags</em>, </td>

  3155.         </tr>

  3156.         <tr>

  3157.           <td class="paramkey"></td>

  3158.           <td></td>

  3159.           <td class="paramtype">uint16_t&#160;</td>

  3160.           <td class="paramname"><em>year</em>, </td>

  3161.         </tr>

  3162.         <tr>

  3163.           <td class="paramkey"></td>

  3164.           <td></td>

  3165.           <td class="paramtype">uint8_t&#160;</td>

  3166.           <td class="paramname"><em>month</em>, </td>

  3167.         </tr>

  3168.         <tr>

  3169.           <td class="paramkey"></td>

  3170.           <td></td>

  3171.           <td class="paramtype">uint8_t&#160;</td>

  3172.           <td class="paramname"><em>day</em>, </td>

  3173.         </tr>

  3174.         <tr>

  3175.           <td class="paramkey"></td>

  3176.           <td></td>

  3177.           <td class="paramtype">uint8_t&#160;</td>

  3178.           <td class="paramname"><em>hour</em>, </td>

  3179.         </tr>

  3180.         <tr>

  3181.           <td class="paramkey"></td>

  3182.           <td></td>

  3183.           <td class="paramtype">uint8_t&#160;</td>

  3184.           <td class="paramname"><em>minute</em>, </td>

  3185.         </tr>

  3186.         <tr>

  3187.           <td class="paramkey"></td>

  3188.           <td></td>

  3189.           <td class="paramtype">uint8_t&#160;</td>

  3190.           <td class="paramname"><em>second</em>&#160;</td>

  3191.         </tr>

  3192.         <tr>

  3193.           <td></td>

  3194.           <td>)</td>

  3195.           <td></td><td></td>

  3196.         </tr>

  3197.       </table>

  3198.   </td>

  3199.   <td class="mlabels-right">

  3200. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3201.   </tr>

  3202. </table>

  3203. </div><div class="memdoc">

  3204. <p>Set a file's timestamps in its directory entry.</p>

  3205. <dl class="params"><dt>Parameters</dt><dd>

  3206.   <table class="params">

  3207.     <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>

  3208.   </table>

  3209.   </dd>

  3210. </dl>

  3211. <p>T_ACCESS - Set the file's last access date.</p>

  3212. <p>T_CREATE - Set the file's creation date and time.</p>

  3213. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3214. <dl class="params"><dt>Parameters</dt><dd>

  3215.   <table class="params">

  3216.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3217.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3218.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3219.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3220.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3221.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3222.   </table>

  3223.   </dd>

  3224. </dl>

  3225. <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>

  3226. <dd>

  3227. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  3228. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3229. 

  3230. </div>

  3231. </div>

  3232. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>

  3233. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  3234. 

  3235. <div class="memitem">

  3236. <div class="memproto">

  3237. <table class="mlabels">

  3238.   <tr>

  3239.   <td class="mlabels-left">

  3240.       <table class="memname">

  3241.         <tr>

  3242.           <td class="memname">bool FatFile::truncate </td>

  3243.           <td>(</td>

  3244.           <td class="paramname"></td><td>)</td>

  3245.           <td></td>

  3246.         </tr>

  3247.       </table>

  3248.   </td>

  3249.   <td class="mlabels-right">

  3250. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3251.   </tr>

  3252. </table>

  3253. </div><div class="memdoc">

  3254. <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>

  3255. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3256. 

  3257. </div>

  3258. </div>

  3259. <a id="aa6e663098a578635d37d92e82d18d616"></a>

  3260. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  3261. 

  3262. <div class="memitem">

  3263. <div class="memproto">

  3264. <table class="mlabels">

  3265.   <tr>

  3266.   <td class="mlabels-left">

  3267.       <table class="memname">

  3268.         <tr>

  3269.           <td class="memname">bool FatFile::truncate </td>

  3270.           <td>(</td>

  3271.           <td class="paramtype">uint32_t&#160;</td>

  3272.           <td class="paramname"><em>length</em></td><td>)</td>

  3273.           <td></td>

  3274.         </tr>

  3275.       </table>

  3276.   </td>

  3277.   <td class="mlabels-right">

  3278. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3279.   </tr>

  3280. </table>

  3281. </div><div class="memdoc">

  3282. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  3283. <dl class="params"><dt>Parameters</dt><dd>

  3284.   <table class="params">

  3285.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3286.   </table>

  3287.   </dd>

  3288. </dl>

  3289. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3290. 

  3291. </div>

  3292. </div>

  3293. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  3294. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[1/4]</span></h2>

  3295. 

  3296. <div class="memitem">

  3297. <div class="memproto">

  3298. <table class="mlabels">

  3299.   <tr>

  3300.   <td class="mlabels-left">

  3301.       <table class="memname">

  3302.         <tr>

  3303.           <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>

  3304.           <td>(</td>

  3305.           <td class="paramtype">uint8_t&#160;</td>

  3306.           <td class="paramname"><em>b</em></td><td>)</td>

  3307.           <td></td>

  3308.         </tr>

  3309.       </table>

  3310.   </td>

  3311.   <td class="mlabels-right">

  3312. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3313.   </tr>

  3314. </table>

  3315. </div><div class="memdoc">

  3316. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3317.   <table class="params">

  3318.     <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>

  3319.   </table>

  3320.   </dd>

  3321. </dl>

  3322. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  3323. 

  3324. </div>

  3325. </div>

  3326. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  3327. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[2/4]</span></h2>

  3328. 

  3329. <div class="memitem">

  3330. <div class="memproto">

  3331. <table class="mlabels">

  3332.   <tr>

  3333.   <td class="mlabels-left">

  3334.       <table class="memname">

  3335.         <tr>

  3336.           <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>

  3337.           <td>(</td>

  3338.           <td class="paramtype">const uint8_t *&#160;</td>

  3339.           <td class="paramname"><em>buffer</em>, </td>

  3340.         </tr>

  3341.         <tr>

  3342.           <td class="paramkey"></td>

  3343.           <td></td>

  3344.           <td class="paramtype">size_t&#160;</td>

  3345.           <td class="paramname"><em>size</em>&#160;</td>

  3346.         </tr>

  3347.         <tr>

  3348.           <td></td>

  3349.           <td>)</td>

  3350.           <td></td><td></td>

  3351.         </tr>

  3352.       </table>

  3353.   </td>

  3354.   <td class="mlabels-right">

  3355. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3356.   </tr>

  3357. </table>

  3358. </div><div class="memdoc">

  3359. <p>Write data to an open file.</p>

  3360. <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>

  3361. <dl class="params"><dt>Parameters</dt><dd>

  3362.   <table class="params">

  3363.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  3364.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  3365.   </table>

  3366.   </dd>

  3367. </dl>

  3368. <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>

  3369. 

  3370. </div>

  3371. </div>

  3372. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>

  3373. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[3/4]</span></h2>

  3374. 

  3375. <div class="memitem">

  3376. <div class="memproto">

  3377. <table class="mlabels">

  3378.   <tr>

  3379.   <td class="mlabels-left">

  3380.       <table class="memname">

  3381.         <tr>

  3382.           <td class="memname">size_t FatFile::write </td>

  3383.           <td>(</td>

  3384.           <td class="paramtype">const char *&#160;</td>

  3385.           <td class="paramname"><em>str</em></td><td>)</td>

  3386.           <td></td>

  3387.         </tr>

  3388.       </table>

  3389.   </td>

  3390.   <td class="mlabels-right">

  3391. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3392.   </tr>

  3393. </table>

  3394. </div><div class="memdoc">

  3395. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3396.   <table class="params">

  3397.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3398.   </table>

  3399.   </dd>

  3400. </dl>

  3401. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3402. 

  3403. </div>

  3404. </div>

  3405. <a id="a5d84d871ac904a22aa48308713d14682"></a>

  3406. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[4/4]</span></h2>

  3407. 

  3408. <div class="memitem">

  3409. <div class="memproto">

  3410. <table class="mlabels">

  3411.   <tr>

  3412.   <td class="mlabels-left">

  3413.       <table class="memname">

  3414.         <tr>

  3415.           <td class="memname">size_t FatFile::write </td>

  3416.           <td>(</td>

  3417.           <td class="paramtype">const void *&#160;</td>

  3418.           <td class="paramname"><em>buf</em>, </td>

  3419.         </tr>

  3420.         <tr>

  3421.           <td class="paramkey"></td>

  3422.           <td></td>

  3423.           <td class="paramtype">size_t&#160;</td>

  3424.           <td class="paramname"><em>count</em>&#160;</td>

  3425.         </tr>

  3426.         <tr>

  3427.           <td></td>

  3428.           <td>)</td>

  3429.           <td></td><td></td>

  3430.         </tr>

  3431.       </table>

  3432.   </td>

  3433.   <td class="mlabels-right">

  3434. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3435.   </tr>

  3436. </table>

  3437. </div><div class="memdoc">

  3438. <p>Write data to an open file.</p>

  3439. <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>

  3440. <dl class="params"><dt>Parameters</dt><dd>

  3441.   <table class="params">

  3442.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3443.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  3444.   </table>

  3445.   </dd>

  3446. </dl>

  3447. <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>

  3448. 

  3449. </div>

  3450. </div>

  3451. <hr/>The documentation for this class was generated from the following file:<ul>

  3452. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  3453. </ul>

  3454. </div><!-- contents -->

  3455. <!-- start footer part -->

  3456. <hr class="footer"/><address class="footer"><small>

  3457. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3458. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3459. </a> 1.8.14

  3460. </small></address>

  3461. </body>

  3462. </html>