visus
/
teensy-sdfat
Sledovat 1
Oblíbit 0
Rozštěpit 0
Zdrojový kód Úkoly 0 Požadavky na natažení 0 Vydání 0 Wiki Aktivita
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
59 Revize
1 Větev
Strom: 97f98028a0
Větve Značky
${ item.name }
Vytvořit větev ${ searchTerm }
z „97f98028a0“
${ noResults }
teensy-sdfat/extras/html/class_sd_file.html

3426 lines
150KB
Surový Blame Historie 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

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

  68.   <div class="headertitle">

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

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

  71. <div class="contents">

  72. 

  73. <p>FAT16/FAT32 file with Print.  

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

  75. 

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

  77. <div class="dynheader">

  78. Inheritance diagram for SdFile:</div>

  79. <div class="dyncontent">

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

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

  82. <area shape="rect" title="FAT16/FAT32 file with Print." alt="" coords="57,155,115,181"/>

  83. <area shape="rect" href="class_print_file.html" title=" " alt="" coords="5,80,167,107"/>

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

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

  86. </map>

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

  88. <div class="dynheader">

  89. Collaboration diagram for SdFile:</div>

  90. <div class="dyncontent">

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

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

  93. <area shape="rect" title="FAT16/FAT32 file with Print." alt="" coords="57,155,115,181"/>

  94. <area shape="rect" href="class_print_file.html" title=" " alt="" coords="5,80,167,107"/>

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

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

  97. </map>

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

  99. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  182. <tr class="memitem:a60ab9d16bcc778150a364c26de467de1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a60ab9d16bcc778150a364c26de467de1">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0, uint8_t indent=0)</td></tr>

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

  184. <tr class="memitem:a6a11f3307da6232b5f2d11812832d93a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6a11f3307da6232b5f2d11812832d93a">ls</a> (uint8_t flags=0)</td></tr>

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

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

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

  188. <tr class="memitem:afd3e4d5a76b6751ca796fc57f4dd2be4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#afd3e4d5a76b6751ca796fc57f4dd2be4">open</a> (const char *path, oflag_t oflag=0X00)</td></tr>

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

  190. <tr class="memitem:a58d6ea245f1bc3ae7a6df311cd25052f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, const char *path, oflag_t oflag)</td></tr>

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

  192. <tr class="memitem:ab44920bb9cd5414b8e69c9dc4343394a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ab44920bb9cd5414b8e69c9dc4343394a">open</a> (<a class="el" href="class_fat_file.html">FatFile</a> *dirFile, uint16_t index, oflag_t oflag)</td></tr>

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

  194. <tr class="memitem:af49a42dc64cd954debb271eae5639059"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">open</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol, const char *path, oflag_t oflag)</td></tr>

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

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

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

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

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

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

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

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

  203. <tr class="separator:ac05b7136b887539426856c623869aa3a"><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#ac62f6449331cfe1a71f29be30efe7890">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#ac62f6449331cfe1a71f29be30efe7890">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#ac62f6449331cfe1a71f29be30efe7890">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#ac62f6449331cfe1a71f29be30efe7890">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#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr)</td></tr>

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

  223. <tr class="memitem:ad1cbc3aeb0f5193b7a26595966da9621"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#ad1cbc3aeb0f5193b7a26595966da9621">printName</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  244. <tr class="separator:a5aac6e0b3cb08fc8b8668e916a8b0ca5"><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:ad05be3a1fb635448d15a154424b6c33f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file.html#ad05be3a1fb635448d15a154424b6c33f">SdFile</a> (const char *path, oflag_t oflag)</td></tr>

  250. <tr class="separator:ad05be3a1fb635448d15a154424b6c33f"><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: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  274. <tr class="memitem:a2d78e6a8cedbf8ce545af68457b43bf1"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file.html#a2d78e6a8cedbf8ce545af68457b43bf1">dateTimeCallback</a> (void(*dateTime)(uint16_t *date, uint16_t *time))</td></tr>

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

  276. <tr class="memitem:ad266770d0a779d1a528a3997aee5142d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file.html#ad266770d0a779d1a528a3997aee5142d">dateTimeCallbackCancel</a> ()</td></tr>

  277. <tr class="separator:ad266770d0a779d1a528a3997aee5142d"><td class="memSeparator" colspan="2">&#160;</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#ac62f6449331cfe1a71f29be30efe7890">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#ac62f6449331cfe1a71f29be30efe7890">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 Print. </p>

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

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

  289. <h2 class="memtitle"><span class="permalink"><a href="#ad05be3a1fb635448d15a154424b6c33f">&#9670;&nbsp;</a></span>SdFile()</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">SdFile::SdFile </td>

  299.           <td>(</td>

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

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

  302.         </tr>

  303.         <tr>

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

  305.           <td></td>

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

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

  308.         </tr>

  309.         <tr>

  310.           <td></td>

  311.           <td>)</td>

  312.           <td></td><td></td>

  313.         </tr>

  314.       </table>

  315.   </td>

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

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

  318.   </tr>

  319. </table>

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

  321. <p>Create an open <a class="el" href="class_sd_file.html" title="FAT16/FAT32 file with Print.">SdFile</a>. </p><dl class="params"><dt>Parameters</dt><dd>

  322.   <table class="params">

  323.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>path for file. </td></tr>

  324.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>

  325.   </table>

  326.   </dd>

  327. </dl>

  328. 

  329. </div>

  330. </div>

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

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

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

  334. 

  335. <div class="memitem">

  336. <div class="memproto">

  337. <table class="mlabels">

  338.   <tr>

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

  340.       <table class="memname">

  341.         <tr>

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

  343.           <td>(</td>

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

  345.           <td></td>

  346.         </tr>

  347.       </table>

  348.   </td>

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

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

  351.   </tr>

  352. </table>

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

  354. <dl class="section return"><dt>Returns</dt><dd>The number of bytes available from the current position to EOF for normal files. INT_MAX is returned for very large files.</dd></dl>

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

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

  357. 

  358. </div>

  359. </div>

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

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

  362. 

  363. <div class="memitem">

  364. <div class="memproto">

  365. <table class="mlabels">

  366.   <tr>

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

  368.       <table class="memname">

  369.         <tr>

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

  371.           <td>(</td>

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

  373.           <td></td>

  374.         </tr>

  375.       </table>

  376.   </td>

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

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

  379.   </tr>

  380. </table>

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

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

  383. 

  384. </div>

  385. </div>

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

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

  388. 

  389. <div class="memitem">

  390. <div class="memproto">

  391. <table class="mlabels">

  392.   <tr>

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

  394.       <table class="memname">

  395.         <tr>

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

  397.           <td>(</td>

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

  399.           <td></td>

  400.         </tr>

  401.       </table>

  402.   </td>

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

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

  405.   </tr>

  406. </table>

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

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

  409. 

  410. </div>

  411. </div>

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

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

  414. 

  415. <div class="memitem">

  416. <div class="memproto">

  417. <table class="mlabels">

  418.   <tr>

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

  420.       <table class="memname">

  421.         <tr>

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

  423.           <td>(</td>

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

  425.           <td></td>

  426.         </tr>

  427.       </table>

  428.   </td>

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

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

  431.   </tr>

  432. </table>

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

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

  435. 

  436. </div>

  437. </div>

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

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

  440. 

  441. <div class="memitem">

  442. <div class="memproto">

  443. <table class="mlabels">

  444.   <tr>

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

  446.       <table class="memname">

  447.         <tr>

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

  449.           <td>(</td>

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

  451.           <td></td>

  452.         </tr>

  453.       </table>

  454.   </td>

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

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

  457.   </tr>

  458. </table>

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

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

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

  462. 

  463. </div>

  464. </div>

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

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

  467. 

  468. <div class="memitem">

  469. <div class="memproto">

  470. <table class="mlabels">

  471.   <tr>

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

  473.       <table class="memname">

  474.         <tr>

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

  476.           <td>(</td>

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

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

  479.         </tr>

  480.         <tr>

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

  482.           <td></td>

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

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

  485.         </tr>

  486.         <tr>

  487.           <td></td>

  488.           <td>)</td>

  489.           <td></td><td></td>

  490.         </tr>

  491.       </table>

  492.   </td>

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

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

  495.   </tr>

  496. </table>

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

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

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

  500.   <table class="params">

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

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

  503.   </table>

  504.   </dd>

  505. </dl>

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

  507. 

  508. </div>

  509. </div>

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

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

  512. 

  513. <div class="memitem">

  514. <div class="memproto">

  515. <table class="mlabels">

  516.   <tr>

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

  518.       <table class="memname">

  519.         <tr>

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

  521.           <td>(</td>

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

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

  524.         </tr>

  525.         <tr>

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

  527.           <td></td>

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

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

  530.         </tr>

  531.         <tr>

  532.           <td></td>

  533.           <td>)</td>

  534.           <td></td><td></td>

  535.         </tr>

  536.       </table>

  537.   </td>

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

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

  540.   </tr>

  541. </table>

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

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

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

  545.   <table class="params">

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

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

  548.   </table>

  549.   </dd>

  550. </dl>

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

  552. 

  553. </div>

  554. </div>

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

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

  557. 

  558. <div class="memitem">

  559. <div class="memproto">

  560. <table class="mlabels">

  561.   <tr>

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

  563.       <table class="memname">

  564.         <tr>

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

  566.           <td>(</td>

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

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

  569.         </tr>

  570.         <tr>

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

  572.           <td></td>

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

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

  575.         </tr>

  576.         <tr>

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

  578.           <td></td>

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

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

  581.         </tr>

  582.         <tr>

  583.           <td></td>

  584.           <td>)</td>

  585.           <td></td><td></td>

  586.         </tr>

  587.       </table>

  588.   </td>

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

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

  591.   </tr>

  592. </table>

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

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

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

  596.   <table class="params">

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

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

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

  600.   </table>

  601.   </dd>

  602. </dl>

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

  604. 

  605. </div>

  606. </div>

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

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

  609. 

  610. <div class="memitem">

  611. <div class="memproto">

  612. <table class="mlabels">

  613.   <tr>

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

  615.       <table class="memname">

  616.         <tr>

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

  618.           <td>(</td>

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

  620.           <td> const</td>

  621.         </tr>

  622.       </table>

  623.   </td>

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

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

  626.   </tr>

  627. </table>

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

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

  630. 

  631. </div>

  632. </div>

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

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

  635. 

  636. <div class="memitem">

  637. <div class="memproto">

  638. <table class="mlabels">

  639.   <tr>

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

  641.       <table class="memname">

  642.         <tr>

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

  644.           <td>(</td>

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

  646.           <td> const</td>

  647.         </tr>

  648.       </table>

  649.   </td>

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

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

  652.   </tr>

  653. </table>

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

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

  656. 

  657. </div>

  658. </div>

  659. <a id="a2d78e6a8cedbf8ce545af68457b43bf1"></a>

  660. <h2 class="memtitle"><span class="permalink"><a href="#a2d78e6a8cedbf8ce545af68457b43bf1">&#9670;&nbsp;</a></span>dateTimeCallback()</h2>

  661. 

  662. <div class="memitem">

  663. <div class="memproto">

  664. <table class="mlabels">

  665.   <tr>

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

  667.       <table class="memname">

  668.         <tr>

  669.           <td class="memname">static void SdFile::dateTimeCallback </td>

  670.           <td>(</td>

  671.           <td class="paramtype">void(*)(uint16_t *date, uint16_t *time)&#160;</td>

  672.           <td class="paramname"><em>dateTime</em></td><td>)</td>

  673.           <td></td>

  674.         </tr>

  675.       </table>

  676.   </td>

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

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

  679.   </tr>

  680. </table>

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

  682. <p>Set the date/time callback function</p>

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

  684.   <table class="params">

  685.     <tr><td class="paramdir">[in]</td><td class="paramname">dateTime</td><td>The user's call back function. The callback function is of the form:</td></tr>

  686.   </table>

  687.   </dd>

  688. </dl>

  689. <div class="fragment"><div class="line"><span class="keywordtype">void</span> dateTime(uint16_t* date, uint16_t* time) {</div>

  690. <div class="line">  uint16_t year;</div>

  691. <div class="line">  uint8_t month, day, hour, minute, second;</div>

  692. <div class="line"> </div>

  693. <div class="line">  <span class="comment">// User gets date and time from GPS or real-time clock here</span></div>

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

  695. <div class="line">  <span class="comment">// return date using FAT_DATE macro to format fields</span></div>

  696. <div class="line">  *date = FAT_DATE(year, month, day);</div>

  697. <div class="line"> </div>

  698. <div class="line">  <span class="comment">// return time using FAT_TIME macro to format fields</span></div>

  699. <div class="line">  *time = FAT_TIME(hour, minute, second);</div>

  700. <div class="line">}</div>

  701. </div><!-- fragment --><p>Sets the function that is called when a file is created or when a file's directory entry is modified by <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a>. All timestamps, access, creation, and modify, are set when a file is created. <a class="el" href="class_fat_file.html#a67f3dc4896c542d695e11aac927f585e">sync()</a> maintains the last access date and last modify date/time. </p>

  702. 

  703. </div>

  704. </div>

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

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

  707. 

  708. <div class="memitem">

  709. <div class="memproto">

  710. <table class="mlabels">

  711.   <tr>

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

  713.       <table class="memname">

  714.         <tr>

  715.           <td class="memname">static void SdFile::dateTimeCallbackCancel </td>

  716.           <td>(</td>

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

  718.           <td></td>

  719.         </tr>

  720.       </table>

  721.   </td>

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

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

  724.   </tr>

  725. </table>

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

  727. <p>Cancel the date/time callback function. </p>

  728. 

  729. </div>

  730. </div>

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

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

  733. 

  734. <div class="memitem">

  735. <div class="memproto">

  736. <table class="mlabels">

  737.   <tr>

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

  739.       <table class="memname">

  740.         <tr>

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

  742.           <td>(</td>

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

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

  745.           <td></td>

  746.         </tr>

  747.       </table>

  748.   </td>

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

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

  751.   </tr>

  752. </table>

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

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

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

  756.   <table class="params">

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

  758.   </table>

  759.   </dd>

  760. </dl>

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

  762. 

  763. </div>

  764. </div>

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

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

  767. 

  768. <div class="memitem">

  769. <div class="memproto">

  770. <table class="mlabels">

  771.   <tr>

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

  773.       <table class="memname">

  774.         <tr>

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

  776.           <td>(</td>

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

  778.           <td></td>

  779.         </tr>

  780.       </table>

  781.   </td>

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

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

  784.   </tr>

  785. </table>

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

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

  788. 

  789. </div>

  790. </div>

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

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

  793. 

  794. <div class="memitem">

  795. <div class="memproto">

  796. <table class="mlabels">

  797.   <tr>

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

  799.       <table class="memname">

  800.         <tr>

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

  802.           <td>(</td>

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

  804.           <td></td>

  805.         </tr>

  806.       </table>

  807.   </td>

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

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

  810.   </tr>

  811. </table>

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

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

  814. 

  815. </div>

  816. </div>

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

  818. <h2 class="memtitle"><span class="permalink"><a href="#a4f01d27954ae49aeb6888ac7302f55d9">&#9670;&nbsp;</a></span>dmpFile()</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">void FatFile::dmpFile </td>

  828.           <td>(</td>

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

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

  831.         </tr>

  832.         <tr>

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

  834.           <td></td>

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

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

  837.         </tr>

  838.         <tr>

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

  840.           <td></td>

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

  842.           <td class="paramname"><em>n</em>&#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>Dump file in Hex </p><dl class="params"><dt>Parameters</dt><dd>

  857.   <table class="params">

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

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

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

  861.   </table>

  862.   </dd>

  863. </dl>

  864. 

  865. </div>

  866. </div>

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

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

  869. 

  870. <div class="memitem">

  871. <div class="memproto">

  872. <table class="mlabels">

  873.   <tr>

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

  875.       <table class="memname">

  876.         <tr>

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

  878.           <td>(</td>

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

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

  881.           <td></td>

  882.         </tr>

  883.       </table>

  884.   </td>

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

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

  887.   </tr>

  888. </table>

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

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

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

  892.   <table class="params">

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

  894.   </table>

  895.   </dd>

  896. </dl>

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

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

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

  900. 

  901. </div>

  902. </div>

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

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

  905. 

  906. <div class="memitem">

  907. <div class="memproto">

  908. <table class="mlabels">

  909.   <tr>

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

  911.       <table class="memname">

  912.         <tr>

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

  914.           <td>(</td>

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

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

  917.           <td></td>

  918.         </tr>

  919.       </table>

  920.   </td>

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

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

  923.   </tr>

  924. </table>

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

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

  927.   <table class="params">

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

  929.   </table>

  930.   </dd>

  931. </dl>

  932. 

  933. </div>

  934. </div>

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

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

  937. 

  938. <div class="memitem">

  939. <div class="memproto">

  940. <table class="mlabels">

  941.   <tr>

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

  943.       <table class="memname">

  944.         <tr>

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

  946.           <td>(</td>

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

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

  949.         </tr>

  950.         <tr>

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

  952.           <td></td>

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

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

  955.         </tr>

  956.         <tr>

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

  958.           <td></td>

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

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

  961.         </tr>

  962.         <tr>

  963.           <td></td>

  964.           <td>)</td>

  965.           <td></td><td></td>

  966.         </tr>

  967.       </table>

  968.   </td>

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

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

  971.   </tr>

  972. </table>

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

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

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

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

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

  978.   <table class="params">

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

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

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

  982.   </table>

  983.   </dd>

  984. </dl>

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

  986. 

  987. </div>

  988. </div>

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

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

  991. 

  992. <div class="memitem">

  993. <div class="memproto">

  994. <table class="mlabels">

  995.   <tr>

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

  997.       <table class="memname">

  998.         <tr>

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

  1000.           <td>(</td>

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

  1002.           <td> const</td>

  1003.         </tr>

  1004.       </table>

  1005.   </td>

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

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

  1008.   </tr>

  1009. </table>

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

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

  1012. 

  1013. </div>

  1014. </div>

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

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

  1017. 

  1018. <div class="memitem">

  1019. <div class="memproto">

  1020. <table class="mlabels">

  1021.   <tr>

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

  1023.       <table class="memname">

  1024.         <tr>

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

  1026.           <td>(</td>

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

  1028.           <td> const</td>

  1029.         </tr>

  1030.       </table>

  1031.   </td>

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

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

  1034.   </tr>

  1035. </table>

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

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

  1038. 

  1039. </div>

  1040. </div>

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

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

  1043. 

  1044. <div class="memitem">

  1045. <div class="memproto">

  1046. <table class="mlabels">

  1047.   <tr>

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

  1049.       <table class="memname">

  1050.         <tr>

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

  1052.           <td>(</td>

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

  1054.           <td> const</td>

  1055.         </tr>

  1056.       </table>

  1057.   </td>

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

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

  1060.   </tr>

  1061. </table>

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

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

  1064. 

  1065. </div>

  1066. </div>

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

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

  1069. 

  1070. <div class="memitem">

  1071. <div class="memproto">

  1072. <table class="mlabels">

  1073.   <tr>

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

  1075.       <table class="memname">

  1076.         <tr>

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

  1078.           <td>(</td>

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

  1080.           <td></td>

  1081.         </tr>

  1082.       </table>

  1083.   </td>

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

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

  1086.   </tr>

  1087. </table>

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

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

  1090. 

  1091. </div>

  1092. </div>

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

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

  1095. 

  1096. <div class="memitem">

  1097. <div class="memproto">

  1098. <table class="mlabels">

  1099.   <tr>

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

  1101.       <table class="memname">

  1102.         <tr>

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

  1104.           <td>(</td>

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

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

  1107.           <td></td>

  1108.         </tr>

  1109.       </table>

  1110.   </td>

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

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

  1113.   </tr>

  1114. </table>

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

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

  1117.   <table class="params">

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

  1119.   </table>

  1120.   </dd>

  1121. </dl>

  1122. 

  1123. </div>

  1124. </div>

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

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

  1127. 

  1128. <div class="memitem">

  1129. <div class="memproto">

  1130. <table class="mlabels">

  1131.   <tr>

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

  1133.       <table class="memname">

  1134.         <tr>

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

  1136.           <td>(</td>

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

  1138.           <td></td>

  1139.         </tr>

  1140.       </table>

  1141.   </td>

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

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

  1144.   </tr>

  1145. </table>

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

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

  1148. 

  1149. </div>

  1150. </div>

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

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

  1153. 

  1154. <div class="memitem">

  1155. <div class="memproto">

  1156. <table class="mlabels">

  1157.   <tr>

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

  1159.       <table class="memname">

  1160.         <tr>

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

  1162.           <td>(</td>

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

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

  1165.         </tr>

  1166.         <tr>

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

  1168.           <td></td>

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

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

  1171.         </tr>

  1172.         <tr>

  1173.           <td></td>

  1174.           <td>)</td>

  1175.           <td></td><td></td>

  1176.         </tr>

  1177.       </table>

  1178.   </td>

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

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

  1181.   </tr>

  1182. </table>

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

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

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

  1186.   <table class="params">

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

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

  1189.   </table>

  1190.   </dd>

  1191. </dl>

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

  1193. 

  1194. </div>

  1195. </div>

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

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

  1198. 

  1199. <div class="memitem">

  1200. <div class="memproto">

  1201. <table class="mlabels">

  1202.   <tr>

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

  1204.       <table class="memname">

  1205.         <tr>

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

  1207.           <td>(</td>

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

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

  1210.           <td></td>

  1211.         </tr>

  1212.       </table>

  1213.   </td>

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

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

  1216.   </tr>

  1217. </table>

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

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

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

  1221.   <table class="params">

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

  1223.   </table>

  1224.   </dd>

  1225. </dl>

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

  1227. 

  1228. </div>

  1229. </div>

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

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

  1232. 

  1233. <div class="memitem">

  1234. <div class="memproto">

  1235. <table class="mlabels">

  1236.   <tr>

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

  1238.       <table class="memname">

  1239.         <tr>

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

  1241.           <td>(</td>

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

  1243.           <td></td>

  1244.         </tr>

  1245.       </table>

  1246.   </td>

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

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

  1249.   </tr>

  1250. </table>

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

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

  1253. 

  1254. </div>

  1255. </div>

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

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

  1258. 

  1259. <div class="memitem">

  1260. <div class="memproto">

  1261. <table class="mlabels">

  1262.   <tr>

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

  1264.       <table class="memname">

  1265.         <tr>

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

  1267.           <td>(</td>

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

  1269.           <td> const</td>

  1270.         </tr>

  1271.       </table>

  1272.   </td>

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

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

  1275.   </tr>

  1276. </table>

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

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

  1279. 

  1280. </div>

  1281. </div>

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

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

  1284. 

  1285. <div class="memitem">

  1286. <div class="memproto">

  1287. <table class="mlabels">

  1288.   <tr>

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

  1290.       <table class="memname">

  1291.         <tr>

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

  1293.           <td>(</td>

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

  1295.           <td> const</td>

  1296.         </tr>

  1297.       </table>

  1298.   </td>

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

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

  1301.   </tr>

  1302. </table>

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

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

  1305. 

  1306. </div>

  1307. </div>

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

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

  1310. 

  1311. <div class="memitem">

  1312. <div class="memproto">

  1313. <table class="mlabels">

  1314.   <tr>

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

  1316.       <table class="memname">

  1317.         <tr>

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

  1319.           <td>(</td>

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

  1321.           <td> const</td>

  1322.         </tr>

  1323.       </table>

  1324.   </td>

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

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

  1327.   </tr>

  1328. </table>

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

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

  1331. 

  1332. </div>

  1333. </div>

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

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

  1336. 

  1337. <div class="memitem">

  1338. <div class="memproto">

  1339. <table class="mlabels">

  1340.   <tr>

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

  1342.       <table class="memname">

  1343.         <tr>

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

  1345.           <td>(</td>

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

  1347.           <td> const</td>

  1348.         </tr>

  1349.       </table>

  1350.   </td>

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

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

  1353.   </tr>

  1354. </table>

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

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

  1357. 

  1358. </div>

  1359. </div>

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

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

  1362. 

  1363. <div class="memitem">

  1364. <div class="memproto">

  1365. <table class="mlabels">

  1366.   <tr>

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

  1368.       <table class="memname">

  1369.         <tr>

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

  1371.           <td>(</td>

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

  1373.           <td> const</td>

  1374.         </tr>

  1375.       </table>

  1376.   </td>

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

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

  1379.   </tr>

  1380. </table>

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

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

  1383. 

  1384. </div>

  1385. </div>

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

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

  1388. 

  1389. <div class="memitem">

  1390. <div class="memproto">

  1391. <table class="mlabels">

  1392.   <tr>

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

  1394.       <table class="memname">

  1395.         <tr>

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

  1397.           <td>(</td>

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

  1399.           <td> const</td>

  1400.         </tr>

  1401.       </table>

  1402.   </td>

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

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

  1405.   </tr>

  1406. </table>

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

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

  1409. 

  1410. </div>

  1411. </div>

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

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

  1414. 

  1415. <div class="memitem">

  1416. <div class="memproto">

  1417. <table class="mlabels">

  1418.   <tr>

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

  1420.       <table class="memname">

  1421.         <tr>

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

  1423.           <td>(</td>

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

  1425.           <td> const</td>

  1426.         </tr>

  1427.       </table>

  1428.   </td>

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

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

  1431.   </tr>

  1432. </table>

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

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

  1435. 

  1436. </div>

  1437. </div>

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

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

  1440. 

  1441. <div class="memitem">

  1442. <div class="memproto">

  1443. <table class="mlabels">

  1444.   <tr>

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

  1446.       <table class="memname">

  1447.         <tr>

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

  1449.           <td>(</td>

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

  1451.           <td> const</td>

  1452.         </tr>

  1453.       </table>

  1454.   </td>

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

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

  1457.   </tr>

  1458. </table>

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

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

  1461. 

  1462. </div>

  1463. </div>

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

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

  1466. 

  1467. <div class="memitem">

  1468. <div class="memproto">

  1469. <table class="mlabels">

  1470.   <tr>

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

  1472.       <table class="memname">

  1473.         <tr>

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

  1475.           <td>(</td>

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

  1477.           <td> const</td>

  1478.         </tr>

  1479.       </table>

  1480.   </td>

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

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

  1483.   </tr>

  1484. </table>

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

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

  1487. 

  1488. </div>

  1489. </div>

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

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

  1492. 

  1493. <div class="memitem">

  1494. <div class="memproto">

  1495. <table class="mlabels">

  1496.   <tr>

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

  1498.       <table class="memname">

  1499.         <tr>

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

  1501.           <td>(</td>

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

  1503.           <td> const</td>

  1504.         </tr>

  1505.       </table>

  1506.   </td>

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

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

  1509.   </tr>

  1510. </table>

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

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

  1513. 

  1514. </div>

  1515. </div>

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

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

  1518. 

  1519. <div class="memitem">

  1520. <div class="memproto">

  1521. <table class="mlabels">

  1522.   <tr>

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

  1524.       <table class="memname">

  1525.         <tr>

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

  1527.           <td>(</td>

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

  1529.           <td> const</td>

  1530.         </tr>

  1531.       </table>

  1532.   </td>

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

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

  1535.   </tr>

  1536. </table>

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

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

  1539. 

  1540. </div>

  1541. </div>

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

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

  1544. 

  1545. <div class="memitem">

  1546. <div class="memproto">

  1547. <table class="mlabels">

  1548.   <tr>

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

  1550.       <table class="memname">

  1551.         <tr>

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

  1553.           <td>(</td>

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

  1555.           <td> const</td>

  1556.         </tr>

  1557.       </table>

  1558.   </td>

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

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

  1561.   </tr>

  1562. </table>

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

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

  1565. 

  1566. </div>

  1567. </div>

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

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

  1570. 

  1571. <div class="memitem">

  1572. <div class="memproto">

  1573. <table class="mlabels">

  1574.   <tr>

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

  1576.       <table class="memname">

  1577.         <tr>

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

  1579.           <td>(</td>

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

  1581.           <td> const</td>

  1582.         </tr>

  1583.       </table>

  1584.   </td>

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

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

  1587.   </tr>

  1588. </table>

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

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

  1591. 

  1592. </div>

  1593. </div>

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

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

  1596. 

  1597. <div class="memitem">

  1598. <div class="memproto">

  1599. <table class="mlabels">

  1600.   <tr>

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

  1602.       <table class="memname">

  1603.         <tr>

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

  1605.           <td>(</td>

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

  1607.           <td> const</td>

  1608.         </tr>

  1609.       </table>

  1610.   </td>

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

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

  1613.   </tr>

  1614. </table>

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

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

  1617. 

  1618. </div>

  1619. </div>

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

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

  1622. 

  1623. <div class="memitem">

  1624. <div class="memproto">

  1625. <table class="mlabels">

  1626.   <tr>

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

  1628.       <table class="memname">

  1629.         <tr>

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

  1631.           <td>(</td>

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

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

  1634.           <td></td>

  1635.         </tr>

  1636.       </table>

  1637.   </td>

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

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

  1640.   </tr>

  1641. </table>

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

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

  1644.   <table class="params">

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

  1646.   </table>

  1647.   </dd>

  1648. </dl>

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

  1650. 

  1651. </div>

  1652. </div>

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

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

  1655. 

  1656. <div class="memitem">

  1657. <div class="memproto">

  1658. <table class="mlabels">

  1659.   <tr>

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

  1661.       <table class="memname">

  1662.         <tr>

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

  1664.           <td>(</td>

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

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

  1667.         </tr>

  1668.         <tr>

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

  1670.           <td></td>

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

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

  1673.         </tr>

  1674.         <tr>

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

  1676.           <td></td>

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

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

  1679.         </tr>

  1680.         <tr>

  1681.           <td></td>

  1682.           <td>)</td>

  1683.           <td></td><td></td>

  1684.         </tr>

  1685.       </table>

  1686.   </td>

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

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

  1689.   </tr>

  1690. </table>

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

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

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

  1694.   <table class="params">

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

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

  1697.   </table>

  1698.   </dd>

  1699. </dl>

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

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

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

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

  1704.   <table class="params">

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

  1706.   </table>

  1707.   </dd>

  1708. </dl>

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

  1710. 

  1711. </div>

  1712. </div>

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

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

  1715. 

  1716. <div class="memitem">

  1717. <div class="memproto">

  1718. <table class="mlabels">

  1719.   <tr>

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

  1721.       <table class="memname">

  1722.         <tr>

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

  1724.           <td>(</td>

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

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

  1727.           <td></td>

  1728.         </tr>

  1729.       </table>

  1730.   </td>

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

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

  1733.   </tr>

  1734. </table>

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

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

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

  1738.   <table class="params">

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

  1740.   </table>

  1741.   </dd>

  1742. </dl>

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

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

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

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

  1747. 

  1748. </div>

  1749. </div>

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

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

  1752. 

  1753. <div class="memitem">

  1754. <div class="memproto">

  1755. <table class="mlabels">

  1756.   <tr>

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

  1758.       <table class="memname">

  1759.         <tr>

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

  1761.           <td>(</td>

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

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

  1764.         </tr>

  1765.         <tr>

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

  1767.           <td></td>

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

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

  1770.         </tr>

  1771.         <tr>

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

  1773.           <td></td>

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

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

  1776.         </tr>

  1777.         <tr>

  1778.           <td></td>

  1779.           <td>)</td>

  1780.           <td></td><td></td>

  1781.         </tr>

  1782.       </table>

  1783.   </td>

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

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

  1786.   </tr>

  1787. </table>

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

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

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

  1791.   <table class="params">

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

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

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

  1795.   </table>

  1796.   </dd>

  1797. </dl>

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

  1799. 

  1800. </div>

  1801. </div>

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

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

  1804. 

  1805. <div class="memitem">

  1806. <div class="memproto">

  1807. <table class="mlabels">

  1808.   <tr>

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

  1810.       <table class="memname">

  1811.         <tr>

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

  1813.           <td>(</td>

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

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

  1816.         </tr>

  1817.         <tr>

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

  1819.           <td></td>

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

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

  1822.         </tr>

  1823.         <tr>

  1824.           <td></td>

  1825.           <td>)</td>

  1826.           <td></td><td></td>

  1827.         </tr>

  1828.       </table>

  1829.   </td>

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

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

  1832.   </tr>

  1833. </table>

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

  1835. <p>Open a file in the current working volume.</p>

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

  1837.   <table class="params">

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

  1839.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>bitwise-inclusive OR of open flags. See see <a class="el" href="class_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>.</td></tr>

  1840.   </table>

  1841.   </dd>

  1842. </dl>

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

  1844. 

  1845. </div>

  1846. </div>

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

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

  1849. 

  1850. <div class="memitem">

  1851. <div class="memproto">

  1852. <table class="mlabels">

  1853.   <tr>

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

  1855.       <table class="memname">

  1856.         <tr>

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

  1858.           <td>(</td>

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

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

  1861.         </tr>

  1862.         <tr>

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

  1864.           <td></td>

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

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

  1867.         </tr>

  1868.         <tr>

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

  1870.           <td></td>

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

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

  1873.         </tr>

  1874.         <tr>

  1875.           <td></td>

  1876.           <td>)</td>

  1877.           <td></td><td></td>

  1878.         </tr>

  1879.       </table>

  1880.   </td>

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

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

  1883.   </tr>

  1884. </table>

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

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

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

  1888.   <table class="params">

  1889.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> instance for the directory containing the file to be opened.</td></tr>

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

  1891.     <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>Values for <em>oflag</em> are constructed by a bitwise-inclusive OR of flags from the following list. Only one of O_RDONLY, O_READ, O_WRONLY, O_WRITE, or O_RDWR is allowed.</td></tr>

  1892.   </table>

  1893.   </dd>

  1894. </dl>

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

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

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

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

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

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

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

  1902. <p>O_CREAT - If the file exists, this flag has no effect except as noted under O_EXCL below. Otherwise, the file shall be created</p>

  1903. <p>O_EXCL - If O_CREAT and O_EXCL are set, <a class="el" href="class_fat_file.html#af49a42dc64cd954debb271eae5639059">open()</a> shall fail if the file exists.</p>

  1904. <p>O_TRUNC - If the file exists and is a regular file, and the file is successfully opened and is not read only, its length shall be truncated to 0.</p>

  1905. <p>WARNING: A given file must not be opened by more than one <a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> object or file corruption may occur.</p>

  1906. <dl class="section note"><dt>Note</dt><dd>Directory files must be opened read only. Write and truncation is not allowed for directory files.</dd></dl>

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

  1908. 

  1909. </div>

  1910. </div>

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

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

  1913. 

  1914. <div class="memitem">

  1915. <div class="memproto">

  1916. <table class="mlabels">

  1917.   <tr>

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

  1919.       <table class="memname">

  1920.         <tr>

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

  1922.           <td>(</td>

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

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

  1925.         </tr>

  1926.         <tr>

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

  1928.           <td></td>

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

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

  1931.         </tr>

  1932.         <tr>

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

  1934.           <td></td>

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

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

  1937.         </tr>

  1938.         <tr>

  1939.           <td></td>

  1940.           <td>)</td>

  1941.           <td></td><td></td>

  1942.         </tr>

  1943.       </table>

  1944.   </td>

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

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

  1947.   </tr>

  1948. </table>

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

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

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

  1952.   <table class="params">

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

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

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

  1956.   </table>

  1957.   </dd>

  1958. </dl>

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

  1960. 

  1961. </div>

  1962. </div>

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

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

  1965. 

  1966. <div class="memitem">

  1967. <div class="memproto">

  1968. <table class="mlabels">

  1969.   <tr>

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

  1971.       <table class="memname">

  1972.         <tr>

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

  1974.           <td>(</td>

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

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

  1977.         </tr>

  1978.         <tr>

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

  1980.           <td></td>

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

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

  1983.         </tr>

  1984.         <tr>

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

  1986.           <td></td>

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

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

  1989.         </tr>

  1990.         <tr>

  1991.           <td></td>

  1992.           <td>)</td>

  1993.           <td></td><td></td>

  1994.         </tr>

  1995.       </table>

  1996.   </td>

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

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

  1999.   </tr>

  2000. </table>

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

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

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

  2004.   <table class="params">

  2005.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>Volume where the file is located.</td></tr>

  2006.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>with a valid name for a file to be opened.</td></tr>

  2007.     <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>

  2008.   </table>

  2009.   </dd>

  2010. </dl>

  2011. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2012. 

  2013. </div>

  2014. </div>

  2015. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>

  2016. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>

  2017. 

  2018. <div class="memitem">

  2019. <div class="memproto">

  2020. <table class="mlabels">

  2021.   <tr>

  2022.   <td class="mlabels-left">

  2023.       <table class="memname">

  2024.         <tr>

  2025.           <td class="memname">bool FatFile::openNext </td>

  2026.           <td>(</td>

  2027.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2028.           <td class="paramname"><em>dirFile</em>, </td>

  2029.         </tr>

  2030.         <tr>

  2031.           <td class="paramkey"></td>

  2032.           <td></td>

  2033.           <td class="paramtype">oflag_t&#160;</td>

  2034.           <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>

  2035.         </tr>

  2036.         <tr>

  2037.           <td></td>

  2038.           <td>)</td>

  2039.           <td></td><td></td>

  2040.         </tr>

  2041.       </table>

  2042.   </td>

  2043.   <td class="mlabels-right">

  2044. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2045.   </tr>

  2046. </table>

  2047. </div><div class="memdoc">

  2048. <p>Open the next file or subdirectory in a directory.</p>

  2049. <dl class="params"><dt>Parameters</dt><dd>

  2050.   <table class="params">

  2051.     <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>

  2052.     <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>

  2053.   </table>

  2054.   </dd>

  2055. </dl>

  2056. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2057. 

  2058. </div>

  2059. </div>

  2060. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  2061. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>

  2062. 

  2063. <div class="memitem">

  2064. <div class="memproto">

  2065. <table class="mlabels">

  2066.   <tr>

  2067.   <td class="mlabels-left">

  2068.       <table class="memname">

  2069.         <tr>

  2070.           <td class="memname">bool FatFile::openRoot </td>

  2071.           <td>(</td>

  2072.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>

  2073.           <td class="paramname"><em>vol</em></td><td>)</td>

  2074.           <td></td>

  2075.         </tr>

  2076.       </table>

  2077.   </td>

  2078.   <td class="mlabels-right">

  2079. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2080.   </tr>

  2081. </table>

  2082. </div><div class="memdoc">

  2083. <p>Open a volume's root directory.</p>

  2084. <dl class="params"><dt>Parameters</dt><dd>

  2085.   <table class="params">

  2086.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  2087.   </table>

  2088.   </dd>

  2089. </dl>

  2090. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2091. 

  2092. </div>

  2093. </div>

  2094. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>

  2095. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>

  2096. 

  2097. <div class="memitem">

  2098. <div class="memproto">

  2099. <table class="mlabels">

  2100.   <tr>

  2101.   <td class="mlabels-left">

  2102.       <table class="memname">

  2103.         <tr>

  2104.           <td class="memname">FatFile::operator bool </td>

  2105.           <td>(</td>

  2106.           <td class="paramname"></td><td>)</td>

  2107.           <td></td>

  2108.         </tr>

  2109.       </table>

  2110.   </td>

  2111.   <td class="mlabels-right">

  2112. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2113.   </tr>

  2114. </table>

  2115. </div><div class="memdoc">

  2116. <p>The parenthesis operator.</p>

  2117. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  2118. 

  2119. </div>

  2120. </div>

  2121. <a id="ac05b7136b887539426856c623869aa3a"></a>

  2122. <h2 class="memtitle"><span class="permalink"><a href="#ac05b7136b887539426856c623869aa3a">&#9670;&nbsp;</a></span>peek()</h2>

  2123. 

  2124. <div class="memitem">

  2125. <div class="memproto">

  2126. <table class="mlabels">

  2127.   <tr>

  2128.   <td class="mlabels-left">

  2129.       <table class="memname">

  2130.         <tr>

  2131.           <td class="memname">int FatFile::peek </td>

  2132.           <td>(</td>

  2133.           <td class="paramname"></td><td>)</td>

  2134.           <td></td>

  2135.         </tr>

  2136.       </table>

  2137.   </td>

  2138.   <td class="mlabels-right">

  2139. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2140.   </tr>

  2141. </table>

  2142. </div><div class="memdoc">

  2143. <p>Return the next available byte without consuming it.</p>

  2144. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  2145. 

  2146. </div>

  2147. </div>

  2148. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>

  2149. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>

  2150. 

  2151. <div class="memitem">

  2152. <div class="memproto">

  2153. <table class="mlabels">

  2154.   <tr>

  2155.   <td class="mlabels-left">

  2156.       <table class="memname">

  2157.         <tr>

  2158.           <td class="memname">bool FatFile::preAllocate </td>

  2159.           <td>(</td>

  2160.           <td class="paramtype">uint32_t&#160;</td>

  2161.           <td class="paramname"><em>length</em></td><td>)</td>

  2162.           <td></td>

  2163.         </tr>

  2164.       </table>

  2165.   </td>

  2166.   <td class="mlabels-right">

  2167. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2168.   </tr>

  2169. </table>

  2170. </div><div class="memdoc">

  2171. <p>Allocate contiguous clusters to an empty file.</p>

  2172. <p>The file must be empty with no clusters allocated.</p>

  2173. <p>The file will contain uninitialized data.</p>

  2174. <dl class="params"><dt>Parameters</dt><dd>

  2175.   <table class="params">

  2176.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  2177.   </table>

  2178.   </dd>

  2179. </dl>

  2180. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2181. 

  2182. </div>

  2183. </div>

  2184. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>

  2185. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</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::printAccessDate </td>

  2195.           <td>(</td>

  2196.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">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 access date</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 characters printed. </dd></dl>

  2215. 

  2216. </div>

  2217. </div>

  2218. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>

  2219. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</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">size_t FatFile::printAccessDateTime </td>

  2229.           <td>(</td>

  2230.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2231.           <td class="paramname"><em>pr</em></td><td>)</td>

  2232.           <td></td>

  2233.         </tr>

  2234.       </table>

  2235.   </td>

  2236.   <td class="mlabels-right">

  2237. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2238.   </tr>

  2239. </table>

  2240. </div><div class="memdoc">

  2241. <p>Print a file's access date</p>

  2242. <dl class="params"><dt>Parameters</dt><dd>

  2243.   <table class="params">

  2244.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2245.   </table>

  2246.   </dd>

  2247. </dl>

  2248. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2249. 

  2250. </div>

  2251. </div>

  2252. <a id="ab22396a285e27b53501a0047ddd97f59"></a>

  2253. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  2254. 

  2255. <div class="memitem">

  2256. <div class="memproto">

  2257. <table class="mlabels">

  2258.   <tr>

  2259.   <td class="mlabels-left">

  2260.       <table class="memname">

  2261.         <tr>

  2262.           <td class="memname">size_t FatFile::printCreateDateTime </td>

  2263.           <td>(</td>

  2264.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2265.           <td class="paramname"><em>pr</em></td><td>)</td>

  2266.           <td></td>

  2267.         </tr>

  2268.       </table>

  2269.   </td>

  2270.   <td class="mlabels-right">

  2271. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2272.   </tr>

  2273. </table>

  2274. </div><div class="memdoc">

  2275. <p>Print a file's creation date and time</p>

  2276. <dl class="params"><dt>Parameters</dt><dd>

  2277.   <table class="params">

  2278.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2279.   </table>

  2280.   </dd>

  2281. </dl>

  2282. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  2283. 

  2284. </div>

  2285. </div>

  2286. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>

  2287. <h2 class="memtitle"><span class="permalink"><a href="#aabcd863883bfcfb37b63dbd6021f7eb8">&#9670;&nbsp;</a></span>printFatDate()</h2>

  2288. 

  2289. <div class="memitem">

  2290. <div class="memproto">

  2291. <table class="mlabels">

  2292.   <tr>

  2293.   <td class="mlabels-left">

  2294.       <table class="memname">

  2295.         <tr>

  2296.           <td class="memname">static void FatFile::printFatDate </td>

  2297.           <td>(</td>

  2298.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2299.           <td class="paramname"><em>pr</em>, </td>

  2300.         </tr>

  2301.         <tr>

  2302.           <td class="paramkey"></td>

  2303.           <td></td>

  2304.           <td class="paramtype">uint16_t&#160;</td>

  2305.           <td class="paramname"><em>fatDate</em>&#160;</td>

  2306.         </tr>

  2307.         <tr>

  2308.           <td></td>

  2309.           <td>)</td>

  2310.           <td></td><td></td>

  2311.         </tr>

  2312.       </table>

  2313.   </td>

  2314.   <td class="mlabels-right">

  2315. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2316.   </tr>

  2317. </table>

  2318. </div><div class="memdoc">

  2319. <p>Print a directory date field.</p>

  2320. <p>Format is yyyy-mm-dd.</p>

  2321. <dl class="params"><dt>Parameters</dt><dd>

  2322.   <table class="params">

  2323.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2324.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2325.   </table>

  2326.   </dd>

  2327. </dl>

  2328. 

  2329. </div>

  2330. </div>

  2331. <a id="a7f84d953190ea94710dad9ebb897b957"></a>

  2332. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>

  2333. 

  2334. <div class="memitem">

  2335. <div class="memproto">

  2336. <table class="mlabels">

  2337.   <tr>

  2338.   <td class="mlabels-left">

  2339.       <table class="memname">

  2340.         <tr>

  2341.           <td class="memname">static void FatFile::printFatTime </td>

  2342.           <td>(</td>

  2343.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2344.           <td class="paramname"><em>pr</em>, </td>

  2345.         </tr>

  2346.         <tr>

  2347.           <td class="paramkey"></td>

  2348.           <td></td>

  2349.           <td class="paramtype">uint16_t&#160;</td>

  2350.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2351.         </tr>

  2352.         <tr>

  2353.           <td></td>

  2354.           <td>)</td>

  2355.           <td></td><td></td>

  2356.         </tr>

  2357.       </table>

  2358.   </td>

  2359.   <td class="mlabels-right">

  2360. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span>  </td>

  2361.   </tr>

  2362. </table>

  2363. </div><div class="memdoc">

  2364. <p>Print a directory time field.</p>

  2365. <p>Format is hh:mm:ss.</p>

  2366. <dl class="params"><dt>Parameters</dt><dd>

  2367.   <table class="params">

  2368.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2369.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2370.   </table>

  2371.   </dd>

  2372. </dl>

  2373. 

  2374. </div>

  2375. </div>

  2376. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>

  2377. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  2378. 

  2379. <div class="memitem">

  2380. <div class="memproto">

  2381. <table class="mlabels">

  2382.   <tr>

  2383.   <td class="mlabels-left">

  2384.       <table class="memname">

  2385.         <tr>

  2386.           <td class="memname">size_t FatFile::printField </td>

  2387.           <td>(</td>

  2388.           <td class="paramtype">double&#160;</td>

  2389.           <td class="paramname"><em>value</em>, </td>

  2390.         </tr>

  2391.         <tr>

  2392.           <td class="paramkey"></td>

  2393.           <td></td>

  2394.           <td class="paramtype">char&#160;</td>

  2395.           <td class="paramname"><em>term</em>, </td>

  2396.         </tr>

  2397.         <tr>

  2398.           <td class="paramkey"></td>

  2399.           <td></td>

  2400.           <td class="paramtype">uint8_t&#160;</td>

  2401.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2402.         </tr>

  2403.         <tr>

  2404.           <td></td>

  2405.           <td>)</td>

  2406.           <td></td><td></td>

  2407.         </tr>

  2408.       </table>

  2409.   </td>

  2410.   <td class="mlabels-right">

  2411. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2412.   </tr>

  2413. </table>

  2414. </div><div class="memdoc">

  2415. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2416.   <table class="params">

  2417.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2418.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2419.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2420.   </table>

  2421.   </dd>

  2422. </dl>

  2423. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2424. 

  2425. </div>

  2426. </div>

  2427. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>

  2428. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  2429. 

  2430. <div class="memitem">

  2431. <div class="memproto">

  2432. <table class="mlabels">

  2433.   <tr>

  2434.   <td class="mlabels-left">

  2435.       <table class="memname">

  2436.         <tr>

  2437.           <td class="memname">size_t FatFile::printField </td>

  2438.           <td>(</td>

  2439.           <td class="paramtype">float&#160;</td>

  2440.           <td class="paramname"><em>value</em>, </td>

  2441.         </tr>

  2442.         <tr>

  2443.           <td class="paramkey"></td>

  2444.           <td></td>

  2445.           <td class="paramtype">char&#160;</td>

  2446.           <td class="paramname"><em>term</em>, </td>

  2447.         </tr>

  2448.         <tr>

  2449.           <td class="paramkey"></td>

  2450.           <td></td>

  2451.           <td class="paramtype">uint8_t&#160;</td>

  2452.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2453.         </tr>

  2454.         <tr>

  2455.           <td></td>

  2456.           <td>)</td>

  2457.           <td></td><td></td>

  2458.         </tr>

  2459.       </table>

  2460.   </td>

  2461.   <td class="mlabels-right">

  2462. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2463.   </tr>

  2464. </table>

  2465. </div><div class="memdoc">

  2466. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2467.   <table class="params">

  2468.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2469.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2470.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2471.   </table>

  2472.   </dd>

  2473. </dl>

  2474. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2475. 

  2476. </div>

  2477. </div>

  2478. <a id="a8f906be79086f38943cb0911310d67bf"></a>

  2479. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  2480. 

  2481. <div class="memitem">

  2482. <div class="memproto">

  2483. <div class="memtemplate">

  2484. template&lt;typename Type &gt; </div>

  2485. <table class="mlabels">

  2486.   <tr>

  2487.   <td class="mlabels-left">

  2488.       <table class="memname">

  2489.         <tr>

  2490.           <td class="memname">size_t FatFile::printField </td>

  2491.           <td>(</td>

  2492.           <td class="paramtype">Type&#160;</td>

  2493.           <td class="paramname"><em>value</em>, </td>

  2494.         </tr>

  2495.         <tr>

  2496.           <td class="paramkey"></td>

  2497.           <td></td>

  2498.           <td class="paramtype">char&#160;</td>

  2499.           <td class="paramname"><em>term</em>&#160;</td>

  2500.         </tr>

  2501.         <tr>

  2502.           <td></td>

  2503.           <td>)</td>

  2504.           <td></td><td></td>

  2505.         </tr>

  2506.       </table>

  2507.   </td>

  2508.   <td class="mlabels-right">

  2509. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2510.   </tr>

  2511. </table>

  2512. </div><div class="memdoc">

  2513. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2514.   <table class="params">

  2515.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2516.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2517.   </table>

  2518.   </dd>

  2519. </dl>

  2520. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2521. 

  2522. </div>

  2523. </div>

  2524. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2525. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</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::printFileSize </td>

  2535.           <td>(</td>

  2536.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">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 size.</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>The number of characters printed is returned for success and zero is returned for failure. </dd></dl>

  2555. 

  2556. </div>

  2557. </div>

  2558. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>

  2559. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</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::printModifyDateTime </td>

  2569.           <td>(</td>

  2570.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">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 modify date and time</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. </dd></dl>

  2589. 

  2590. </div>

  2591. </div>

  2592. <a id="ad1cbc3aeb0f5193b7a26595966da9621"></a>

  2593. <h2 class="memtitle"><span class="permalink"><a href="#ad1cbc3aeb0f5193b7a26595966da9621">&#9670;&nbsp;</a></span>printName() <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">size_t FatFile::printName </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>Print a file's name.</p>

  2615. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2616. 

  2617. </div>

  2618. </div>

  2619. <a id="afe18a787fb8640e2d2483370c770f82f"></a>

  2620. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName() <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">size_t FatFile::printName </td>

  2630.           <td>(</td>

  2631.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2632.           <td class="paramname"><em>pr</em></td><td>)</td>

  2633.           <td></td>

  2634.         </tr>

  2635.       </table>

  2636.   </td>

  2637.   <td class="mlabels-right">

  2638. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2639.   </tr>

  2640. </table>

  2641. </div><div class="memdoc">

  2642. <p>Print a file's name</p>

  2643. <dl class="params"><dt>Parameters</dt><dd>

  2644.   <table class="params">

  2645.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2646.   </table>

  2647.   </dd>

  2648. </dl>

  2649. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2650. 

  2651. </div>

  2652. </div>

  2653. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2654. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>

  2655. 

  2656. <div class="memitem">

  2657. <div class="memproto">

  2658. <table class="mlabels">

  2659.   <tr>

  2660.   <td class="mlabels-left">

  2661.       <table class="memname">

  2662.         <tr>

  2663.           <td class="memname">size_t FatFile::printSFN </td>

  2664.           <td>(</td>

  2665.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2666.           <td class="paramname"><em>pr</em></td><td>)</td>

  2667.           <td></td>

  2668.         </tr>

  2669.       </table>

  2670.   </td>

  2671.   <td class="mlabels-right">

  2672. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2673.   </tr>

  2674. </table>

  2675. </div><div class="memdoc">

  2676. <p>Print a file's Short File Name.</p>

  2677. <dl class="params"><dt>Parameters</dt><dd>

  2678.   <table class="params">

  2679.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2680.   </table>

  2681.   </dd>

  2682. </dl>

  2683. <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>

  2684. 

  2685. </div>

  2686. </div>

  2687. <a id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2688. <h2 class="memtitle"><span class="permalink"><a href="#a60ae55ff6fe158c2340071d702a363c5">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  2689. 

  2690. <div class="memitem">

  2691. <div class="memproto">

  2692. <table class="mlabels">

  2693.   <tr>

  2694.   <td class="mlabels-left">

  2695.       <table class="memname">

  2696.         <tr>

  2697.           <td class="memname">int FatFile::read </td>

  2698.           <td>(</td>

  2699.           <td class="paramname"></td><td>)</td>

  2700.           <td></td>

  2701.         </tr>

  2702.       </table>

  2703.   </td>

  2704.   <td class="mlabels-right">

  2705. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2706.   </tr>

  2707. </table>

  2708. </div><div class="memdoc">

  2709. <p>Read the next byte from a file.</p>

  2710. <dl class="section return"><dt>Returns</dt><dd>For success read returns the next byte in the file as an int. If an error occurs or end of file is reached -1 is returned. </dd></dl>

  2711. 

  2712. </div>

  2713. </div>

  2714. <a id="aba893af8107a18017482d2311b066187"></a>

  2715. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2716. 

  2717. <div class="memitem">

  2718. <div class="memproto">

  2719. <table class="mlabels">

  2720.   <tr>

  2721.   <td class="mlabels-left">

  2722.       <table class="memname">

  2723.         <tr>

  2724.           <td class="memname">int FatFile::read </td>

  2725.           <td>(</td>

  2726.           <td class="paramtype">void *&#160;</td>

  2727.           <td class="paramname"><em>buf</em>, </td>

  2728.         </tr>

  2729.         <tr>

  2730.           <td class="paramkey"></td>

  2731.           <td></td>

  2732.           <td class="paramtype">size_t&#160;</td>

  2733.           <td class="paramname"><em>count</em>&#160;</td>

  2734.         </tr>

  2735.         <tr>

  2736.           <td></td>

  2737.           <td>)</td>

  2738.           <td></td><td></td>

  2739.         </tr>

  2740.       </table>

  2741.   </td>

  2742.   <td class="mlabels-right">

  2743. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2744.   </tr>

  2745. </table>

  2746. </div><div class="memdoc">

  2747. <p>Read data from a file starting at the current position.</p>

  2748. <dl class="params"><dt>Parameters</dt><dd>

  2749.   <table class="params">

  2750.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2751.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2752.   </table>

  2753.   </dd>

  2754. </dl>

  2755. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> returns the number of bytes read. A value less than <em>nbyte</em>, including zero, will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a60ae55ff6fe158c2340071d702a363c5">read()</a> returns -1. </dd></dl>

  2756. 

  2757. </div>

  2758. </div>

  2759. <a id="a29502cd34ef186763d2196daef27df1f"></a>

  2760. <h2 class="memtitle"><span class="permalink"><a href="#a29502cd34ef186763d2196daef27df1f">&#9670;&nbsp;</a></span>readDir()</h2>

  2761. 

  2762. <div class="memitem">

  2763. <div class="memproto">

  2764. <table class="mlabels">

  2765.   <tr>

  2766.   <td class="mlabels-left">

  2767.       <table class="memname">

  2768.         <tr>

  2769.           <td class="memname">int8_t FatFile::readDir </td>

  2770.           <td>(</td>

  2771.           <td class="paramtype">DirFat_t *&#160;</td>

  2772.           <td class="paramname"><em>dir</em></td><td>)</td>

  2773.           <td></td>

  2774.         </tr>

  2775.       </table>

  2776.   </td>

  2777.   <td class="mlabels-right">

  2778. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2779.   </tr>

  2780. </table>

  2781. </div><div class="memdoc">

  2782. <p>Read the next directory entry from a directory file.</p>

  2783. <dl class="params"><dt>Parameters</dt><dd>

  2784.   <table class="params">

  2785.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The DirFat_t struct that will receive the data.</td></tr>

  2786.   </table>

  2787.   </dd>

  2788. </dl>

  2789. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir()</a> returns the number of bytes read. A value of zero will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a29502cd34ef186763d2196daef27df1f">readDir()</a> called before a directory has been opened, this is not a directory file or an I/O error occurred. </dd></dl>

  2790. 

  2791. </div>

  2792. </div>

  2793. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2794. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2795. 

  2796. <div class="memitem">

  2797. <div class="memproto">

  2798. <table class="mlabels">

  2799.   <tr>

  2800.   <td class="mlabels-left">

  2801.       <table class="memname">

  2802.         <tr>

  2803.           <td class="memname">bool FatFile::remove </td>

  2804.           <td>(</td>

  2805.           <td class="paramname"></td><td>)</td>

  2806.           <td></td>

  2807.         </tr>

  2808.       </table>

  2809.   </td>

  2810.   <td class="mlabels-right">

  2811. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2812.   </tr>

  2813. </table>

  2814. </div><div class="memdoc">

  2815. <p>Remove a file.</p>

  2816. <p>The directory entry and all data for the file are deleted.</p>

  2817. <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>

  2818. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2819. 

  2820. </div>

  2821. </div>

  2822. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>

  2823. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2824. 

  2825. <div class="memitem">

  2826. <div class="memproto">

  2827. <table class="mlabels">

  2828.   <tr>

  2829.   <td class="mlabels-left">

  2830.       <table class="memname">

  2831.         <tr>

  2832.           <td class="memname">bool FatFile::remove </td>

  2833.           <td>(</td>

  2834.           <td class="paramtype">const char *&#160;</td>

  2835.           <td class="paramname"><em>path</em></td><td>)</td>

  2836.           <td></td>

  2837.         </tr>

  2838.       </table>

  2839.   </td>

  2840.   <td class="mlabels-right">

  2841. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2842.   </tr>

  2843. </table>

  2844. </div><div class="memdoc">

  2845. <p>Remove a file.</p>

  2846. <p>The directory entry and all data for the file are deleted.</p>

  2847. <dl class="params"><dt>Parameters</dt><dd>

  2848.   <table class="params">

  2849.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2850.   </table>

  2851.   </dd>

  2852. </dl>

  2853. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2854. <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>

  2855. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2856. 

  2857. </div>

  2858. </div>

  2859. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>

  2860. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2861. 

  2862. <div class="memitem">

  2863. <div class="memproto">

  2864. <table class="mlabels">

  2865.   <tr>

  2866.   <td class="mlabels-left">

  2867.       <table class="memname">

  2868.         <tr>

  2869.           <td class="memname">bool FatFile::rename </td>

  2870.           <td>(</td>

  2871.           <td class="paramtype">const char *&#160;</td>

  2872.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2873.           <td></td>

  2874.         </tr>

  2875.       </table>

  2876.   </td>

  2877.   <td class="mlabels-right">

  2878. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2879.   </tr>

  2880. </table>

  2881. </div><div class="memdoc">

  2882. <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>

  2883. <dl class="params"><dt>Parameters</dt><dd>

  2884.   <table class="params">

  2885.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2886.   </table>

  2887.   </dd>

  2888. </dl>

  2889. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2890. 

  2891. </div>

  2892. </div>

  2893. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2894. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2895. 

  2896. <div class="memitem">

  2897. <div class="memproto">

  2898. <table class="mlabels">

  2899.   <tr>

  2900.   <td class="mlabels-left">

  2901.       <table class="memname">

  2902.         <tr>

  2903.           <td class="memname">bool FatFile::rename </td>

  2904.           <td>(</td>

  2905.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2906.           <td class="paramname"><em>dirFile</em>, </td>

  2907.         </tr>

  2908.         <tr>

  2909.           <td class="paramkey"></td>

  2910.           <td></td>

  2911.           <td class="paramtype">const char *&#160;</td>

  2912.           <td class="paramname"><em>newPath</em>&#160;</td>

  2913.         </tr>

  2914.         <tr>

  2915.           <td></td>

  2916.           <td>)</td>

  2917.           <td></td><td></td>

  2918.         </tr>

  2919.       </table>

  2920.   </td>

  2921.   <td class="mlabels-right">

  2922. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2923.   </tr>

  2924. </table>

  2925. </div><div class="memdoc">

  2926. <p>Rename a file or subdirectory.</p>

  2927. <dl class="params"><dt>Parameters</dt><dd>

  2928.   <table class="params">

  2929.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2930.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2931.   </table>

  2932.   </dd>

  2933. </dl>

  2934. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2935. 

  2936. </div>

  2937. </div>

  2938. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2939. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>

  2940. 

  2941. <div class="memitem">

  2942. <div class="memproto">

  2943. <table class="mlabels">

  2944.   <tr>

  2945.   <td class="mlabels-left">

  2946.       <table class="memname">

  2947.         <tr>

  2948.           <td class="memname">void FatFile::rewind </td>

  2949.           <td>(</td>

  2950.           <td class="paramname"></td><td>)</td>

  2951.           <td></td>

  2952.         </tr>

  2953.       </table>

  2954.   </td>

  2955.   <td class="mlabels-right">

  2956. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2957.   </tr>

  2958. </table>

  2959. </div><div class="memdoc">

  2960. <p>Set the file's current position to zero. </p>

  2961. 

  2962. </div>

  2963. </div>

  2964. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2965. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>

  2966. 

  2967. <div class="memitem">

  2968. <div class="memproto">

  2969. <table class="mlabels">

  2970.   <tr>

  2971.   <td class="mlabels-left">

  2972.       <table class="memname">

  2973.         <tr>

  2974.           <td class="memname">bool FatFile::rmdir </td>

  2975.           <td>(</td>

  2976.           <td class="paramname"></td><td>)</td>

  2977.           <td></td>

  2978.         </tr>

  2979.       </table>

  2980.   </td>

  2981.   <td class="mlabels-right">

  2982. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  2983.   </tr>

  2984. </table>

  2985. </div><div class="memdoc">

  2986. <p>Remove a directory file.</p>

  2987. <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>

  2988. <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>

  2989. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2990. 

  2991. </div>

  2992. </div>

  2993. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2994. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>

  2995. 

  2996. <div class="memitem">

  2997. <div class="memproto">

  2998. <table class="mlabels">

  2999.   <tr>

  3000.   <td class="mlabels-left">

  3001.       <table class="memname">

  3002.         <tr>

  3003.           <td class="memname">bool FatFile::rmRfStar </td>

  3004.           <td>(</td>

  3005.           <td class="paramname"></td><td>)</td>

  3006.           <td></td>

  3007.         </tr>

  3008.       </table>

  3009.   </td>

  3010.   <td class="mlabels-right">

  3011. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3012.   </tr>

  3013. </table>

  3014. </div><div class="memdoc">

  3015. <p>Recursively delete a directory and all contained files.</p>

  3016. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  3017. <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>

  3018. <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>

  3019. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3020. 

  3021. </div>

  3022. </div>

  3023. <a id="a5812037ea30777cc350698ad26f2c73f"></a>

  3024. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>

  3025. 

  3026. <div class="memitem">

  3027. <div class="memproto">

  3028. <table class="mlabels">

  3029.   <tr>

  3030.   <td class="mlabels-left">

  3031.       <table class="memname">

  3032.         <tr>

  3033.           <td class="memname">bool FatFile::seekCur </td>

  3034.           <td>(</td>

  3035.           <td class="paramtype">int32_t&#160;</td>

  3036.           <td class="paramname"><em>offset</em></td><td>)</td>

  3037.           <td></td>

  3038.         </tr>

  3039.       </table>

  3040.   </td>

  3041.   <td class="mlabels-right">

  3042. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3043.   </tr>

  3044. </table>

  3045. </div><div class="memdoc">

  3046. <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>

  3047.   <table class="params">

  3048.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  3049.   </table>

  3050.   </dd>

  3051. </dl>

  3052. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3053. 

  3054. </div>

  3055. </div>

  3056. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  3057. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>

  3058. 

  3059. <div class="memitem">

  3060. <div class="memproto">

  3061. <table class="mlabels">

  3062.   <tr>

  3063.   <td class="mlabels-left">

  3064.       <table class="memname">

  3065.         <tr>

  3066.           <td class="memname">bool FatFile::seekEnd </td>

  3067.           <td>(</td>

  3068.           <td class="paramtype">int32_t&#160;</td>

  3069.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  3070.           <td></td>

  3071.         </tr>

  3072.       </table>

  3073.   </td>

  3074.   <td class="mlabels-right">

  3075. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3076.   </tr>

  3077. </table>

  3078. </div><div class="memdoc">

  3079. <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>

  3080.   <table class="params">

  3081.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  3082.   </table>

  3083.   </dd>

  3084. </dl>

  3085. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3086. 

  3087. </div>

  3088. </div>

  3089. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>

  3090. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>

  3091. 

  3092. <div class="memitem">

  3093. <div class="memproto">

  3094. <table class="mlabels">

  3095.   <tr>

  3096.   <td class="mlabels-left">

  3097.       <table class="memname">

  3098.         <tr>

  3099.           <td class="memname">bool FatFile::seekSet </td>

  3100.           <td>(</td>

  3101.           <td class="paramtype">uint32_t&#160;</td>

  3102.           <td class="paramname"><em>pos</em></td><td>)</td>

  3103.           <td></td>

  3104.         </tr>

  3105.       </table>

  3106.   </td>

  3107.   <td class="mlabels-right">

  3108. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3109.   </tr>

  3110. </table>

  3111. </div><div class="memdoc">

  3112. <p>Sets a file's position.</p>

  3113. <dl class="params"><dt>Parameters</dt><dd>

  3114.   <table class="params">

  3115.     <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>

  3116.   </table>

  3117.   </dd>

  3118. </dl>

  3119. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3120. 

  3121. </div>

  3122. </div>

  3123. <a id="a67f3dc4896c542d695e11aac927f585e"></a>

  3124. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>

  3125. 

  3126. <div class="memitem">

  3127. <div class="memproto">

  3128. <table class="mlabels">

  3129.   <tr>

  3130.   <td class="mlabels-left">

  3131.       <table class="memname">

  3132.         <tr>

  3133.           <td class="memname">bool FatFile::sync </td>

  3134.           <td>(</td>

  3135.           <td class="paramname"></td><td>)</td>

  3136.           <td></td>

  3137.         </tr>

  3138.       </table>

  3139.   </td>

  3140.   <td class="mlabels-right">

  3141. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3142.   </tr>

  3143. </table>

  3144. </div><div class="memdoc">

  3145. <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>

  3146. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3147. 

  3148. </div>

  3149. </div>

  3150. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  3151. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>

  3152. 

  3153. <div class="memitem">

  3154. <div class="memproto">

  3155. <table class="mlabels">

  3156.   <tr>

  3157.   <td class="mlabels-left">

  3158.       <table class="memname">

  3159.         <tr>

  3160.           <td class="memname">bool FatFile::timestamp </td>

  3161.           <td>(</td>

  3162.           <td class="paramtype">uint8_t&#160;</td>

  3163.           <td class="paramname"><em>flags</em>, </td>

  3164.         </tr>

  3165.         <tr>

  3166.           <td class="paramkey"></td>

  3167.           <td></td>

  3168.           <td class="paramtype">uint16_t&#160;</td>

  3169.           <td class="paramname"><em>year</em>, </td>

  3170.         </tr>

  3171.         <tr>

  3172.           <td class="paramkey"></td>

  3173.           <td></td>

  3174.           <td class="paramtype">uint8_t&#160;</td>

  3175.           <td class="paramname"><em>month</em>, </td>

  3176.         </tr>

  3177.         <tr>

  3178.           <td class="paramkey"></td>

  3179.           <td></td>

  3180.           <td class="paramtype">uint8_t&#160;</td>

  3181.           <td class="paramname"><em>day</em>, </td>

  3182.         </tr>

  3183.         <tr>

  3184.           <td class="paramkey"></td>

  3185.           <td></td>

  3186.           <td class="paramtype">uint8_t&#160;</td>

  3187.           <td class="paramname"><em>hour</em>, </td>

  3188.         </tr>

  3189.         <tr>

  3190.           <td class="paramkey"></td>

  3191.           <td></td>

  3192.           <td class="paramtype">uint8_t&#160;</td>

  3193.           <td class="paramname"><em>minute</em>, </td>

  3194.         </tr>

  3195.         <tr>

  3196.           <td class="paramkey"></td>

  3197.           <td></td>

  3198.           <td class="paramtype">uint8_t&#160;</td>

  3199.           <td class="paramname"><em>second</em>&#160;</td>

  3200.         </tr>

  3201.         <tr>

  3202.           <td></td>

  3203.           <td>)</td>

  3204.           <td></td><td></td>

  3205.         </tr>

  3206.       </table>

  3207.   </td>

  3208.   <td class="mlabels-right">

  3209. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3210.   </tr>

  3211. </table>

  3212. </div><div class="memdoc">

  3213. <p>Set a file's timestamps in its directory entry.</p>

  3214. <dl class="params"><dt>Parameters</dt><dd>

  3215.   <table class="params">

  3216.     <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>

  3217.   </table>

  3218.   </dd>

  3219. </dl>

  3220. <p>T_ACCESS - Set the file's last access date.</p>

  3221. <p>T_CREATE - Set the file's creation date and time.</p>

  3222. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  3223. <dl class="params"><dt>Parameters</dt><dd>

  3224.   <table class="params">

  3225.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  3226.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  3227.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  3228.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  3229.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  3230.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  3231.   </table>

  3232.   </dd>

  3233. </dl>

  3234. <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>

  3235. <dd>

  3236. Modify and access timestamps may be overwritten if a date time callback function has been set by <a class="el" href="class_sd_file.html#a2d78e6a8cedbf8ce545af68457b43bf1">dateTimeCallback()</a>.</dd></dl>

  3237. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3238. 

  3239. </div>

  3240. </div>

  3241. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>

  3242. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  3243. 

  3244. <div class="memitem">

  3245. <div class="memproto">

  3246. <table class="mlabels">

  3247.   <tr>

  3248.   <td class="mlabels-left">

  3249.       <table class="memname">

  3250.         <tr>

  3251.           <td class="memname">bool FatFile::truncate </td>

  3252.           <td>(</td>

  3253.           <td class="paramname"></td><td>)</td>

  3254.           <td></td>

  3255.         </tr>

  3256.       </table>

  3257.   </td>

  3258.   <td class="mlabels-right">

  3259. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3260.   </tr>

  3261. </table>

  3262. </div><div class="memdoc">

  3263. <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>

  3264. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3265. 

  3266. </div>

  3267. </div>

  3268. <a id="aa6e663098a578635d37d92e82d18d616"></a>

  3269. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  3270. 

  3271. <div class="memitem">

  3272. <div class="memproto">

  3273. <table class="mlabels">

  3274.   <tr>

  3275.   <td class="mlabels-left">

  3276.       <table class="memname">

  3277.         <tr>

  3278.           <td class="memname">bool FatFile::truncate </td>

  3279.           <td>(</td>

  3280.           <td class="paramtype">uint32_t&#160;</td>

  3281.           <td class="paramname"><em>length</em></td><td>)</td>

  3282.           <td></td>

  3283.         </tr>

  3284.       </table>

  3285.   </td>

  3286.   <td class="mlabels-right">

  3287. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3288.   </tr>

  3289. </table>

  3290. </div><div class="memdoc">

  3291. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  3292. <dl class="params"><dt>Parameters</dt><dd>

  3293.   <table class="params">

  3294.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  3295.   </table>

  3296.   </dd>

  3297. </dl>

  3298. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  3299. 

  3300. </div>

  3301. </div>

  3302. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>

  3303. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  3304. 

  3305. <div class="memitem">

  3306. <div class="memproto">

  3307. <table class="mlabels">

  3308.   <tr>

  3309.   <td class="mlabels-left">

  3310.       <table class="memname">

  3311.         <tr>

  3312.           <td class="memname">size_t FatFile::write </td>

  3313.           <td>(</td>

  3314.           <td class="paramtype">const char *&#160;</td>

  3315.           <td class="paramname"><em>str</em></td><td>)</td>

  3316.           <td></td>

  3317.         </tr>

  3318.       </table>

  3319.   </td>

  3320.   <td class="mlabels-right">

  3321. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3322.   </tr>

  3323. </table>

  3324. </div><div class="memdoc">

  3325. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  3326.   <table class="params">

  3327.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  3328.   </table>

  3329.   </dd>

  3330. </dl>

  3331. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  3332. 

  3333. </div>

  3334. </div>

  3335. <a id="a5d84d871ac904a22aa48308713d14682"></a>

  3336. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  3337. 

  3338. <div class="memitem">

  3339. <div class="memproto">

  3340. <table class="mlabels">

  3341.   <tr>

  3342.   <td class="mlabels-left">

  3343.       <table class="memname">

  3344.         <tr>

  3345.           <td class="memname">size_t FatFile::write </td>

  3346.           <td>(</td>

  3347.           <td class="paramtype">const void *&#160;</td>

  3348.           <td class="paramname"><em>buf</em>, </td>

  3349.         </tr>

  3350.         <tr>

  3351.           <td class="paramkey"></td>

  3352.           <td></td>

  3353.           <td class="paramtype">size_t&#160;</td>

  3354.           <td class="paramname"><em>count</em>&#160;</td>

  3355.         </tr>

  3356.         <tr>

  3357.           <td></td>

  3358.           <td>)</td>

  3359.           <td></td><td></td>

  3360.         </tr>

  3361.       </table>

  3362.   </td>

  3363.   <td class="mlabels-right">

  3364. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  3365.   </tr>

  3366. </table>

  3367. </div><div class="memdoc">

  3368. <p>Write data to an open file.</p>

  3369. <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>

  3370. <dl class="params"><dt>Parameters</dt><dd>

  3371.   <table class="params">

  3372.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  3373.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  3374.   </table>

  3375.   </dd>

  3376. </dl>

  3377. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_print_file.html#a52f78f160083b416d66e23c680e0577d">write()</a> returns the number of bytes written, always <em>count</em>. If an error occurs, <a class="el" href="class_print_file.html#a52f78f160083b416d66e23c680e0577d">write()</a> returns -1. Possible errors include <a class="el" href="class_print_file.html#a52f78f160083b416d66e23c680e0577d">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>

  3378. 

  3379. </div>

  3380. </div>

  3381. <a id="a52f78f160083b416d66e23c680e0577d"></a>

  3382. <h2 class="memtitle"><span class="permalink"><a href="#a52f78f160083b416d66e23c680e0577d">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  3383. 

  3384. <div class="memitem">

  3385. <div class="memproto">

  3386. <table class="mlabels">

  3387.   <tr>

  3388.   <td class="mlabels-left">

  3389.       <table class="memname">

  3390.         <tr>

  3391.           <td class="memname">size_t <a class="el" href="class_print_file.html">PrintFile</a>&lt; <a class="el" href="_sd_fat_8h.html#a3991b0f70199d1a17dbb837bb041e89c">SdBaseFile</a>  &gt;::write </td>

  3392.           <td>(</td>

  3393.           <td class="paramtype">uint8_t&#160;</td>

  3394.           <td class="paramname"><em>b</em></td><td>)</td>

  3395.           <td></td>

  3396.         </tr>

  3397.       </table>

  3398.   </td>

  3399.   <td class="mlabels-right">

  3400. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  3401.   </tr>

  3402. </table>

  3403. </div><div class="memdoc">

  3404. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  3405.   <table class="params">

  3406.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>byte to write. </td></tr>

  3407.   </table>

  3408.   </dd>

  3409. </dl>

  3410. <dl class="section return"><dt>Returns</dt><dd>one for success. </dd></dl>

  3411. 

  3412. </div>

  3413. </div>

  3414. <hr/>The documentation for this class was generated from the following file:<ul>

  3415. <li>ArduinoSdFat/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  3416. </ul>

  3417. </div><!-- contents -->

  3418. <!-- start footer part -->

  3419. <hr class="footer"/><address class="footer"><small>

  3420. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  3421. <img class="footer" src="doxygen.png" alt="doxygen"/>

  3422. </a> 1.8.16

  3423. </small></address>

  3424. </body>

  3425. </html>