visus
/
teensy-sdfat
Слідкувати 1
В обрані 0
Форк 0
Код Проблеми 0 Запити на злиття 0 Релізи 0 Вікі Активність
Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
48 Коміти
1 Гілка
Дерево: 40b41c8764
Гілки Теги
${ item.name }
Створити гілку ${ searchTerm }
з '40b41c8764'
${ noResults }
teensy-sdfat/extras/html/class_fat_file.html

2968 lines
135KB
Неформатований Blame Історія 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

  67. <a href="#friends">Friends</a> &#124;

  68. <a href="class_fat_file-members.html">List of all members</a>  </div>

  69.   <div class="headertitle">

  70. <div class="title">FatFile Class Reference</div>  </div>

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

  72. <div class="contents">

  73. 

  74. <p>Basic file class.  

  75.  <a href="class_fat_file.html#details">More...</a></p>

  76. 

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

  78. <div class="dynheader">

  79. Inheritance diagram for FatFile:</div>

  80. <div class="dyncontent">

  81. <div class="center"><img src="class_fat_file__inherit__graph.png" border="0" usemap="#_fat_file_inherit__map" alt="Inheritance graph"/></div>

  82. <map name="_fat_file_inherit__map" id="_fat_file_inherit__map">

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

  84. <area shape="rect" id="node3" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream. " alt="" coords="47,169,105,196"/>

  85. </map>

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

  87. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  260. <tr class="memitem:aabcd863883bfcfb37b63dbd6021f7eb8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#aabcd863883bfcfb37b63dbd6021f7eb8">printFatDate</a> (<a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint16_t fatDate)</td></tr>

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

  262. <tr class="memitem:a7f84d953190ea94710dad9ebb897b957"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a7f84d953190ea94710dad9ebb897b957">printFatTime</a> (<a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint16_t fatTime)</td></tr>

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

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

  265. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  266. Friends</h2></td></tr>

  267. <tr class="memitem:a6ca3f436167f187097347a20ea221555"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file.html#a6ca3f436167f187097347a20ea221555">FatVolume</a></td></tr>

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

  269. </table>

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

  271. <div class="textblock"><p>Basic file class. </p>

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

  273. <a id="a7b591c9b92165fa8e4eae8c30c30e533"></a>

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

  275. 

  276. <div class="memitem">

  277. <div class="memproto">

  278. <table class="mlabels">

  279.   <tr>

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

  281.       <table class="memname">

  282.         <tr>

  283.           <td class="memname">FatFile::FatFile </td>

  284.           <td>(</td>

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

  286.           <td></td>

  287.         </tr>

  288.       </table>

  289.   </td>

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

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

  292.   </tr>

  293. </table>

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

  295. <p>Create an instance. </p>

  296. 

  297. </div>

  298. </div>

  299. <a id="a38f9a296138648d6135cbbbf41ef6b92"></a>

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

  301. 

  302. <div class="memitem">

  303. <div class="memproto">

  304. <table class="mlabels">

  305.   <tr>

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

  307.       <table class="memname">

  308.         <tr>

  309.           <td class="memname">FatFile::FatFile </td>

  310.           <td>(</td>

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

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

  313.         </tr>

  314.         <tr>

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

  316.           <td></td>

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

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

  319.         </tr>

  320.         <tr>

  321.           <td></td>

  322.           <td>)</td>

  323.           <td></td><td></td>

  324.         </tr>

  325.       </table>

  326.   </td>

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

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

  329.   </tr>

  330. </table>

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

  332. <p>Create a file object and open it in the current working directory.</p>

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

  334.   <table class="params">

  335.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path for a file to be opened.</td></tr>

  336.     <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 open flags. see <a class="el" href="class_fat_file.html#a58d6ea245f1bc3ae7a6df311cd25052f">FatFile::open(FatFile*, const char*, uint8_t)</a>. </td></tr>

  337.   </table>

  338.   </dd>

  339. </dl>

  340. 

  341. </div>

  342. </div>

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

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

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

  346. 

  347. <div class="memitem">

  348. <div class="memproto">

  349. <table class="mlabels">

  350.   <tr>

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

  352.       <table class="memname">

  353.         <tr>

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

  355.           <td>(</td>

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

  357.           <td></td>

  358.         </tr>

  359.       </table>

  360.   </td>

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

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

  363.   </tr>

  364. </table>

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

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

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

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

  369. 

  370. </div>

  371. </div>

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

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

  374. 

  375. <div class="memitem">

  376. <div class="memproto">

  377. <table class="mlabels">

  378.   <tr>

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

  380.       <table class="memname">

  381.         <tr>

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

  383.           <td>(</td>

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

  385.           <td></td>

  386.         </tr>

  387.       </table>

  388.   </td>

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

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

  391.   </tr>

  392. </table>

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

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

  395. 

  396. </div>

  397. </div>

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

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

  400. 

  401. <div class="memitem">

  402. <div class="memproto">

  403. <table class="mlabels">

  404.   <tr>

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

  406.       <table class="memname">

  407.         <tr>

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

  409.           <td>(</td>

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

  411.           <td></td>

  412.         </tr>

  413.       </table>

  414.   </td>

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

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

  417.   </tr>

  418. </table>

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

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

  421. 

  422. </div>

  423. </div>

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

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

  426. 

  427. <div class="memitem">

  428. <div class="memproto">

  429. <table class="mlabels">

  430.   <tr>

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

  432.       <table class="memname">

  433.         <tr>

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

  435.           <td>(</td>

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

  437.           <td></td>

  438.         </tr>

  439.       </table>

  440.   </td>

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

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

  443.   </tr>

  444. </table>

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

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

  447. 

  448. </div>

  449. </div>

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

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

  452. 

  453. <div class="memitem">

  454. <div class="memproto">

  455.       <table class="memname">

  456.         <tr>

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

  458.           <td>(</td>

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

  460.           <td></td>

  461.         </tr>

  462.       </table>

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

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

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

  466. 

  467. </div>

  468. </div>

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

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

  471. 

  472. <div class="memitem">

  473. <div class="memproto">

  474.       <table class="memname">

  475.         <tr>

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

  477.           <td>(</td>

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

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

  480.         </tr>

  481.         <tr>

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

  483.           <td></td>

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

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

  486.         </tr>

  487.         <tr>

  488.           <td></td>

  489.           <td>)</td>

  490.           <td></td><td></td>

  491.         </tr>

  492.       </table>

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

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

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

  496.   <table class="params">

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

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

  499.   </table>

  500.   </dd>

  501. </dl>

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

  503. 

  504. </div>

  505. </div>

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

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

  508. 

  509. <div class="memitem">

  510. <div class="memproto">

  511.       <table class="memname">

  512.         <tr>

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

  514.           <td>(</td>

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

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

  517.         </tr>

  518.         <tr>

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

  520.           <td></td>

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

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

  523.         </tr>

  524.         <tr>

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

  526.           <td></td>

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

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

  529.         </tr>

  530.         <tr>

  531.           <td></td>

  532.           <td>)</td>

  533.           <td></td><td></td>

  534.         </tr>

  535.       </table>

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

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

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

  539.   <table class="params">

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

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

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

  543.   </table>

  544.   </dd>

  545. </dl>

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

  547. 

  548. </div>

  549. </div>

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

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

  552. 

  553. <div class="memitem">

  554. <div class="memproto">

  555.       <table class="memname">

  556.         <tr>

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

  558.           <td>(</td>

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

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

  561.         </tr>

  562.         <tr>

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

  564.           <td></td>

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

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

  567.         </tr>

  568.         <tr>

  569.           <td></td>

  570.           <td>)</td>

  571.           <td></td><td></td>

  572.         </tr>

  573.       </table>

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

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

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

  577.   <table class="params">

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

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

  580.   </table>

  581.   </dd>

  582. </dl>

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

  584. 

  585. </div>

  586. </div>

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

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

  589. 

  590. <div class="memitem">

  591. <div class="memproto">

  592. <table class="mlabels">

  593.   <tr>

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

  595.       <table class="memname">

  596.         <tr>

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

  598.           <td>(</td>

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

  600.           <td> const</td>

  601.         </tr>

  602.       </table>

  603.   </td>

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

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

  606.   </tr>

  607. </table>

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

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

  610. 

  611. </div>

  612. </div>

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

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

  615. 

  616. <div class="memitem">

  617. <div class="memproto">

  618. <table class="mlabels">

  619.   <tr>

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

  621.       <table class="memname">

  622.         <tr>

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

  624.           <td>(</td>

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

  626.           <td> const</td>

  627.         </tr>

  628.       </table>

  629.   </td>

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

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

  632.   </tr>

  633. </table>

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

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

  636. 

  637. </div>

  638. </div>

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

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

  641. 

  642. <div class="memitem">

  643. <div class="memproto">

  644.       <table class="memname">

  645.         <tr>

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

  647.           <td>(</td>

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

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

  650.           <td></td>

  651.         </tr>

  652.       </table>

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

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

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

  656.   <table class="params">

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

  658.   </table>

  659.   </dd>

  660. </dl>

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

  662. 

  663. </div>

  664. </div>

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

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

  667. 

  668. <div class="memitem">

  669. <div class="memproto">

  670. <table class="mlabels">

  671.   <tr>

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

  673.       <table class="memname">

  674.         <tr>

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

  676.           <td>(</td>

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

  678.           <td></td>

  679.         </tr>

  680.       </table>

  681.   </td>

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

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

  684.   </tr>

  685. </table>

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

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

  688. 

  689. </div>

  690. </div>

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

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

  693. 

  694. <div class="memitem">

  695. <div class="memproto">

  696.       <table class="memname">

  697.         <tr>

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

  699.           <td>(</td>

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

  701.           <td></td>

  702.         </tr>

  703.       </table>

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

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

  706. 

  707. </div>

  708. </div>

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

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

  711. 

  712. <div class="memitem">

  713. <div class="memproto">

  714.       <table class="memname">

  715.         <tr>

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

  717.           <td>(</td>

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

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

  720.         </tr>

  721.         <tr>

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

  723.           <td></td>

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

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

  726.         </tr>

  727.         <tr>

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

  729.           <td></td>

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

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

  732.         </tr>

  733.         <tr>

  734.           <td></td>

  735.           <td>)</td>

  736.           <td></td><td></td>

  737.         </tr>

  738.       </table>

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

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

  741.   <table class="params">

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

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

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

  745.   </table>

  746.   </dd>

  747. </dl>

  748. 

  749. </div>

  750. </div>

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

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

  753. 

  754. <div class="memitem">

  755. <div class="memproto">

  756. <table class="mlabels">

  757.   <tr>

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

  759.       <table class="memname">

  760.         <tr>

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

  762.           <td>(</td>

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

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

  765.           <td></td>

  766.         </tr>

  767.       </table>

  768.   </td>

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

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

  771.   </tr>

  772. </table>

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

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

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

  776.   <table class="params">

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

  778.   </table>

  779.   </dd>

  780. </dl>

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

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

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

  784. 

  785. </div>

  786. </div>

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

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

  789. 

  790. <div class="memitem">

  791. <div class="memproto">

  792.       <table class="memname">

  793.         <tr>

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

  795.           <td>(</td>

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

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

  798.           <td></td>

  799.         </tr>

  800.       </table>

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

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

  803.   <table class="params">

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

  805.   </table>

  806.   </dd>

  807. </dl>

  808. 

  809. </div>

  810. </div>

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

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

  813. 

  814. <div class="memitem">

  815. <div class="memproto">

  816.       <table class="memname">

  817.         <tr>

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

  819.           <td>(</td>

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

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

  822.         </tr>

  823.         <tr>

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

  825.           <td></td>

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

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

  828.         </tr>

  829.         <tr>

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

  831.           <td></td>

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

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

  834.         </tr>

  835.         <tr>

  836.           <td></td>

  837.           <td>)</td>

  838.           <td></td><td></td>

  839.         </tr>

  840.       </table>

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

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

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

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

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

  846.   <table class="params">

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

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

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

  850.   </table>

  851.   </dd>

  852. </dl>

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

  854. 

  855. </div>

  856. </div>

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

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

  859. 

  860. <div class="memitem">

  861. <div class="memproto">

  862. <table class="mlabels">

  863.   <tr>

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

  865.       <table class="memname">

  866.         <tr>

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

  868.           <td>(</td>

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

  870.           <td> const</td>

  871.         </tr>

  872.       </table>

  873.   </td>

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

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

  876.   </tr>

  877. </table>

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

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

  880. 

  881. </div>

  882. </div>

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

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

  885. 

  886. <div class="memitem">

  887. <div class="memproto">

  888. <table class="mlabels">

  889.   <tr>

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

  891.       <table class="memname">

  892.         <tr>

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

  894.           <td>(</td>

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

  896.           <td> const</td>

  897.         </tr>

  898.       </table>

  899.   </td>

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

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

  902.   </tr>

  903. </table>

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

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

  906. 

  907. </div>

  908. </div>

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

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

  911. 

  912. <div class="memitem">

  913. <div class="memproto">

  914.       <table class="memname">

  915.         <tr>

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

  917.           <td>(</td>

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

  919.           <td> const</td>

  920.         </tr>

  921.       </table>

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

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

  924. 

  925. </div>

  926. </div>

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

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

  929. 

  930. <div class="memitem">

  931. <div class="memproto">

  932. <table class="mlabels">

  933.   <tr>

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

  935.       <table class="memname">

  936.         <tr>

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

  938.           <td>(</td>

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

  940.           <td></td>

  941.         </tr>

  942.       </table>

  943.   </td>

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

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

  946.   </tr>

  947. </table>

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

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

  950. 

  951. </div>

  952. </div>

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

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

  955. 

  956. <div class="memitem">

  957. <div class="memproto">

  958.       <table class="memname">

  959.         <tr>

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

  961.           <td>(</td>

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

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

  964.           <td></td>

  965.         </tr>

  966.       </table>

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

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

  969.   <table class="params">

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

  971.   </table>

  972.   </dd>

  973. </dl>

  974. 

  975. </div>

  976. </div>

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

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

  979. 

  980. <div class="memitem">

  981. <div class="memproto">

  982. <table class="mlabels">

  983.   <tr>

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

  985.       <table class="memname">

  986.         <tr>

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

  988.           <td>(</td>

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

  990.           <td></td>

  991.         </tr>

  992.       </table>

  993.   </td>

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

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

  996.   </tr>

  997. </table>

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

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

  1000. 

  1001. </div>

  1002. </div>

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

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

  1005. 

  1006. <div class="memitem">

  1007. <div class="memproto">

  1008.       <table class="memname">

  1009.         <tr>

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

  1011.           <td>(</td>

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

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

  1014.         </tr>

  1015.         <tr>

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

  1017.           <td></td>

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

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

  1020.         </tr>

  1021.         <tr>

  1022.           <td></td>

  1023.           <td>)</td>

  1024.           <td></td><td></td>

  1025.         </tr>

  1026.       </table>

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

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

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

  1030.   <table class="params">

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

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

  1033.   </table>

  1034.   </dd>

  1035. </dl>

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

  1037. 

  1038. </div>

  1039. </div>

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

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

  1042. 

  1043. <div class="memitem">

  1044. <div class="memproto">

  1045.       <table class="memname">

  1046.         <tr>

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

  1048.           <td>(</td>

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

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

  1051.           <td></td>

  1052.         </tr>

  1053.       </table>

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

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

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

  1057.   <table class="params">

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

  1059.   </table>

  1060.   </dd>

  1061. </dl>

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

  1063. 

  1064. </div>

  1065. </div>

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

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

  1068. 

  1069. <div class="memitem">

  1070. <div class="memproto">

  1071. <table class="mlabels">

  1072.   <tr>

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

  1074.       <table class="memname">

  1075.         <tr>

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

  1077.           <td>(</td>

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

  1079.           <td></td>

  1080.         </tr>

  1081.       </table>

  1082.   </td>

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

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

  1085.   </tr>

  1086. </table>

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

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

  1089. 

  1090. </div>

  1091. </div>

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

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

  1094. 

  1095. <div class="memitem">

  1096. <div class="memproto">

  1097. <table class="mlabels">

  1098.   <tr>

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

  1100.       <table class="memname">

  1101.         <tr>

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

  1103.           <td>(</td>

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

  1105.           <td> const</td>

  1106.         </tr>

  1107.       </table>

  1108.   </td>

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

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

  1111.   </tr>

  1112. </table>

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

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

  1115. 

  1116. </div>

  1117. </div>

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

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

  1120. 

  1121. <div class="memitem">

  1122. <div class="memproto">

  1123. <table class="mlabels">

  1124.   <tr>

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

  1126.       <table class="memname">

  1127.         <tr>

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

  1129.           <td>(</td>

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

  1131.           <td> const</td>

  1132.         </tr>

  1133.       </table>

  1134.   </td>

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

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

  1137.   </tr>

  1138. </table>

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

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

  1141. 

  1142. </div>

  1143. </div>

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

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

  1146. 

  1147. <div class="memitem">

  1148. <div class="memproto">

  1149. <table class="mlabels">

  1150.   <tr>

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

  1152.       <table class="memname">

  1153.         <tr>

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

  1155.           <td>(</td>

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

  1157.           <td> const</td>

  1158.         </tr>

  1159.       </table>

  1160.   </td>

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

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

  1163.   </tr>

  1164. </table>

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

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

  1167. 

  1168. </div>

  1169. </div>

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

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

  1172. 

  1173. <div class="memitem">

  1174. <div class="memproto">

  1175. <table class="mlabels">

  1176.   <tr>

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

  1178.       <table class="memname">

  1179.         <tr>

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

  1181.           <td>(</td>

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

  1183.           <td> const</td>

  1184.         </tr>

  1185.       </table>

  1186.   </td>

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

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

  1189.   </tr>

  1190. </table>

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

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

  1193. 

  1194. </div>

  1195. </div>

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

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

  1207.           <td>(</td>

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

  1209.           <td> const</td>

  1210.         </tr>

  1211.       </table>

  1212.   </td>

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

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

  1215.   </tr>

  1216. </table>

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

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

  1219. 

  1220. </div>

  1221. </div>

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

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

  1224. 

  1225. <div class="memitem">

  1226. <div class="memproto">

  1227. <table class="mlabels">

  1228.   <tr>

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

  1230.       <table class="memname">

  1231.         <tr>

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

  1233.           <td>(</td>

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

  1235.           <td> const</td>

  1236.         </tr>

  1237.       </table>

  1238.   </td>

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

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

  1241.   </tr>

  1242. </table>

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

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

  1245. 

  1246. </div>

  1247. </div>

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

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

  1250. 

  1251. <div class="memitem">

  1252. <div class="memproto">

  1253. <table class="mlabels">

  1254.   <tr>

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

  1256.       <table class="memname">

  1257.         <tr>

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

  1259.           <td>(</td>

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

  1261.           <td> const</td>

  1262.         </tr>

  1263.       </table>

  1264.   </td>

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

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

  1267.   </tr>

  1268. </table>

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

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

  1271. 

  1272. </div>

  1273. </div>

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

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

  1276. 

  1277. <div class="memitem">

  1278. <div class="memproto">

  1279. <table class="mlabels">

  1280.   <tr>

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

  1282.       <table class="memname">

  1283.         <tr>

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

  1285.           <td>(</td>

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

  1287.           <td> const</td>

  1288.         </tr>

  1289.       </table>

  1290.   </td>

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

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

  1293.   </tr>

  1294. </table>

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

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

  1297. 

  1298. </div>

  1299. </div>

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

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

  1302. 

  1303. <div class="memitem">

  1304. <div class="memproto">

  1305. <table class="mlabels">

  1306.   <tr>

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

  1308.       <table class="memname">

  1309.         <tr>

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

  1311.           <td>(</td>

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

  1313.           <td> const</td>

  1314.         </tr>

  1315.       </table>

  1316.   </td>

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

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

  1319.   </tr>

  1320. </table>

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

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

  1323. 

  1324. </div>

  1325. </div>

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

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

  1328. 

  1329. <div class="memitem">

  1330. <div class="memproto">

  1331. <table class="mlabels">

  1332.   <tr>

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

  1334.       <table class="memname">

  1335.         <tr>

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

  1337.           <td>(</td>

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

  1339.           <td> const</td>

  1340.         </tr>

  1341.       </table>

  1342.   </td>

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

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

  1345.   </tr>

  1346. </table>

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

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

  1349. 

  1350. </div>

  1351. </div>

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

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

  1354. 

  1355. <div class="memitem">

  1356. <div class="memproto">

  1357. <table class="mlabels">

  1358.   <tr>

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

  1360.       <table class="memname">

  1361.         <tr>

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

  1363.           <td>(</td>

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

  1365.           <td> const</td>

  1366.         </tr>

  1367.       </table>

  1368.   </td>

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

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

  1371.   </tr>

  1372. </table>

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

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

  1375. 

  1376. </div>

  1377. </div>

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

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

  1380. 

  1381. <div class="memitem">

  1382. <div class="memproto">

  1383. <table class="mlabels">

  1384.   <tr>

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

  1386.       <table class="memname">

  1387.         <tr>

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

  1389.           <td>(</td>

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

  1391.           <td> const</td>

  1392.         </tr>

  1393.       </table>

  1394.   </td>

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

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

  1397.   </tr>

  1398. </table>

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

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

  1401. 

  1402. </div>

  1403. </div>

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

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

  1406. 

  1407. <div class="memitem">

  1408. <div class="memproto">

  1409. <table class="mlabels">

  1410.   <tr>

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

  1412.       <table class="memname">

  1413.         <tr>

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

  1415.           <td>(</td>

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

  1417.           <td> const</td>

  1418.         </tr>

  1419.       </table>

  1420.   </td>

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

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

  1423.   </tr>

  1424. </table>

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

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

  1427. 

  1428. </div>

  1429. </div>

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

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

  1432. 

  1433. <div class="memitem">

  1434. <div class="memproto">

  1435. <table class="mlabels">

  1436.   <tr>

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

  1438.       <table class="memname">

  1439.         <tr>

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

  1441.           <td>(</td>

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

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

  1444.           <td></td>

  1445.         </tr>

  1446.       </table>

  1447.   </td>

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

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

  1450.   </tr>

  1451. </table>

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

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

  1454.   <table class="params">

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

  1456.   </table>

  1457.   </dd>

  1458. </dl>

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

  1460. 

  1461. </div>

  1462. </div>

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

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

  1465. 

  1466. <div class="memitem">

  1467. <div class="memproto">

  1468.       <table class="memname">

  1469.         <tr>

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

  1471.           <td>(</td>

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

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

  1474.         </tr>

  1475.         <tr>

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

  1477.           <td></td>

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

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

  1480.         </tr>

  1481.         <tr>

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

  1483.           <td></td>

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

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

  1486.         </tr>

  1487.         <tr>

  1488.           <td></td>

  1489.           <td>)</td>

  1490.           <td></td><td></td>

  1491.         </tr>

  1492.       </table>

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

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

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

  1496.   <table class="params">

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

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

  1499.   </table>

  1500.   </dd>

  1501. </dl>

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

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

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

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

  1506.   <table class="params">

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

  1508.   </table>

  1509.   </dd>

  1510. </dl>

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

  1512. 

  1513. </div>

  1514. </div>

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

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

  1517. 

  1518. <div class="memitem">

  1519. <div class="memproto">

  1520.       <table class="memname">

  1521.         <tr>

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

  1523.           <td>(</td>

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

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

  1526.         </tr>

  1527.         <tr>

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

  1529.           <td></td>

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

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

  1532.         </tr>

  1533.         <tr>

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

  1535.           <td></td>

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

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

  1538.         </tr>

  1539.         <tr>

  1540.           <td></td>

  1541.           <td>)</td>

  1542.           <td></td><td></td>

  1543.         </tr>

  1544.       </table>

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

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

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

  1548.   <table class="params">

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

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

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

  1552.   </table>

  1553.   </dd>

  1554. </dl>

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

  1556. 

  1557. </div>

  1558. </div>

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

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

  1561. 

  1562. <div class="memitem">

  1563. <div class="memproto">

  1564.       <table class="memname">

  1565.         <tr>

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

  1567.           <td>(</td>

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

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

  1570.         </tr>

  1571.         <tr>

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

  1573.           <td></td>

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

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

  1576.         </tr>

  1577.         <tr>

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

  1579.           <td></td>

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

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

  1582.         </tr>

  1583.         <tr>

  1584.           <td></td>

  1585.           <td>)</td>

  1586.           <td></td><td></td>

  1587.         </tr>

  1588.       </table>

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

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

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

  1592.   <table class="params">

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

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

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

  1596.   </table>

  1597.   </dd>

  1598. </dl>

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

  1600. 

  1601. </div>

  1602. </div>

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

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

  1605. 

  1606. <div class="memitem">

  1607. <div class="memproto">

  1608.       <table class="memname">

  1609.         <tr>

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

  1611.           <td>(</td>

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

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

  1614.         </tr>

  1615.         <tr>

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

  1617.           <td></td>

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

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

  1620.         </tr>

  1621.         <tr>

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

  1623.           <td></td>

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

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

  1626.         </tr>

  1627.         <tr>

  1628.           <td></td>

  1629.           <td>)</td>

  1630.           <td></td><td></td>

  1631.         </tr>

  1632.       </table>

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

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

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

  1636.   <table class="params">

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

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

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

  1640.   </table>

  1641.   </dd>

  1642. </dl>

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

  1644. 

  1645. </div>

  1646. </div>

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

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

  1649. 

  1650. <div class="memitem">

  1651. <div class="memproto">

  1652.       <table class="memname">

  1653.         <tr>

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

  1655.           <td>(</td>

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

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

  1658.         </tr>

  1659.         <tr>

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

  1661.           <td></td>

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

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

  1664.         </tr>

  1665.         <tr>

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

  1667.           <td></td>

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

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

  1670.         </tr>

  1671.         <tr>

  1672.           <td></td>

  1673.           <td>)</td>

  1674.           <td></td><td></td>

  1675.         </tr>

  1676.       </table>

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

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

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

  1680.   <table class="params">

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

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

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

  1684.   </table>

  1685.   </dd>

  1686. </dl>

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

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

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

  1690. <p>O_WRITE - Same as O_WRONLY.</p>

  1691. <p>O_RDWR - Open for reading and writing.</p>

  1692. <p>O_APPEND - If set, the file offset shall be set to the end of the file prior to each write.</p>

  1693. <p>O_AT_END - Set the initial position at the end of the file.</p>

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

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

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

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

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

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

  1700. 

  1701. </div>

  1702. </div>

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

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

  1705. 

  1706. <div class="memitem">

  1707. <div class="memproto">

  1708.       <table class="memname">

  1709.         <tr>

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

  1711.           <td>(</td>

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

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

  1714.         </tr>

  1715.         <tr>

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

  1717.           <td></td>

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

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

  1720.         </tr>

  1721.         <tr>

  1722.           <td></td>

  1723.           <td>)</td>

  1724.           <td></td><td></td>

  1725.         </tr>

  1726.       </table>

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

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

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

  1730.   <table class="params">

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

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

  1733.   </table>

  1734.   </dd>

  1735. </dl>

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

  1737. 

  1738. </div>

  1739. </div>

  1740. <a id="a7f98b908a686574efbd7e1d20121ef9a"></a>

  1741. <h2 class="memtitle"><span class="permalink"><a href="#a7f98b908a686574efbd7e1d20121ef9a">&#9670;&nbsp;</a></span>openNext()</h2>

  1742. 

  1743. <div class="memitem">

  1744. <div class="memproto">

  1745.       <table class="memname">

  1746.         <tr>

  1747.           <td class="memname">bool FatFile::openNext </td>

  1748.           <td>(</td>

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

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

  1751.         </tr>

  1752.         <tr>

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

  1754.           <td></td>

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

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

  1757.         </tr>

  1758.         <tr>

  1759.           <td></td>

  1760.           <td>)</td>

  1761.           <td></td><td></td>

  1762.         </tr>

  1763.       </table>

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

  1765. <p>Open the next file or subdirectory in a directory.</p>

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

  1767.   <table class="params">

  1768.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>An open <a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> instance for the directory containing the file to be opened.</td></tr>

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

  1770.   </table>

  1771.   </dd>

  1772. </dl>

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

  1774. 

  1775. </div>

  1776. </div>

  1777. <a id="a7e0c0548fed3a69e7284b91b694439d4"></a>

  1778. <h2 class="memtitle"><span class="permalink"><a href="#a7e0c0548fed3a69e7284b91b694439d4">&#9670;&nbsp;</a></span>openRoot()</h2>

  1779. 

  1780. <div class="memitem">

  1781. <div class="memproto">

  1782.       <table class="memname">

  1783.         <tr>

  1784.           <td class="memname">bool FatFile::openRoot </td>

  1785.           <td>(</td>

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

  1787.           <td class="paramname"><em>vol</em></td><td>)</td>

  1788.           <td></td>

  1789.         </tr>

  1790.       </table>

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

  1792. <p>Open a volume's root directory.</p>

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

  1794.   <table class="params">

  1795.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td>The FAT volume containing the root directory to be opened.</td></tr>

  1796.   </table>

  1797.   </dd>

  1798. </dl>

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

  1800. 

  1801. </div>

  1802. </div>

  1803. <a id="acd141c43d03cf790b3b9806f3b059e77"></a>

  1804. <h2 class="memtitle"><span class="permalink"><a href="#acd141c43d03cf790b3b9806f3b059e77">&#9670;&nbsp;</a></span>operator bool()</h2>

  1805. 

  1806. <div class="memitem">

  1807. <div class="memproto">

  1808. <table class="mlabels">

  1809.   <tr>

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

  1811.       <table class="memname">

  1812.         <tr>

  1813.           <td class="memname">FatFile::operator bool </td>

  1814.           <td>(</td>

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

  1816.           <td></td>

  1817.         </tr>

  1818.       </table>

  1819.   </td>

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

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

  1822.   </tr>

  1823. </table>

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

  1825. <p>The parenthesis operator.</p>

  1826. <dl class="section return"><dt>Returns</dt><dd>true if a file is open. </dd></dl>

  1827. 

  1828. </div>

  1829. </div>

  1830. <a id="ac05b7136b887539426856c623869aa3a"></a>

  1831. <h2 class="memtitle"><span class="permalink"><a href="#ac05b7136b887539426856c623869aa3a">&#9670;&nbsp;</a></span>peek()</h2>

  1832. 

  1833. <div class="memitem">

  1834. <div class="memproto">

  1835.       <table class="memname">

  1836.         <tr>

  1837.           <td class="memname">int FatFile::peek </td>

  1838.           <td>(</td>

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

  1840.           <td></td>

  1841.         </tr>

  1842.       </table>

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

  1844. <p>Return the next available byte without consuming it.</p>

  1845. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  1846. 

  1847. </div>

  1848. </div>

  1849. <a id="aeeb13b9de68bf9097c863c41d655ee83"></a>

  1850. <h2 class="memtitle"><span class="permalink"><a href="#aeeb13b9de68bf9097c863c41d655ee83">&#9670;&nbsp;</a></span>preAllocate()</h2>

  1851. 

  1852. <div class="memitem">

  1853. <div class="memproto">

  1854.       <table class="memname">

  1855.         <tr>

  1856.           <td class="memname">bool FatFile::preAllocate </td>

  1857.           <td>(</td>

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

  1859.           <td class="paramname"><em>length</em></td><td>)</td>

  1860.           <td></td>

  1861.         </tr>

  1862.       </table>

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

  1864. <p>Allocate contiguous clusters to an empty file.</p>

  1865. <p>The file must be empty with no clusters allocated.</p>

  1866. <p>The file will contain uninitialized data.</p>

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

  1868.   <table class="params">

  1869.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>size of the file in bytes. </td></tr>

  1870.   </table>

  1871.   </dd>

  1872. </dl>

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

  1874. 

  1875. </div>

  1876. </div>

  1877. <a id="a22be4c339d0bfa331f75415b74dd4f37"></a>

  1878. <h2 class="memtitle"><span class="permalink"><a href="#a22be4c339d0bfa331f75415b74dd4f37">&#9670;&nbsp;</a></span>printAccessDate()</h2>

  1879. 

  1880. <div class="memitem">

  1881. <div class="memproto">

  1882.       <table class="memname">

  1883.         <tr>

  1884.           <td class="memname">size_t FatFile::printAccessDate </td>

  1885.           <td>(</td>

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

  1887.           <td class="paramname"><em>pr</em></td><td>)</td>

  1888.           <td></td>

  1889.         </tr>

  1890.       </table>

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

  1892. <p>Print a file's access date</p>

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

  1894.   <table class="params">

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

  1896.   </table>

  1897.   </dd>

  1898. </dl>

  1899. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  1900. 

  1901. </div>

  1902. </div>

  1903. <a id="a19b3196bb1f6a68a2447e53b09369aef"></a>

  1904. <h2 class="memtitle"><span class="permalink"><a href="#a19b3196bb1f6a68a2447e53b09369aef">&#9670;&nbsp;</a></span>printAccessDateTime()</h2>

  1905. 

  1906. <div class="memitem">

  1907. <div class="memproto">

  1908. <table class="mlabels">

  1909.   <tr>

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

  1911.       <table class="memname">

  1912.         <tr>

  1913.           <td class="memname">size_t FatFile::printAccessDateTime </td>

  1914.           <td>(</td>

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

  1916.           <td class="paramname"><em>pr</em></td><td>)</td>

  1917.           <td></td>

  1918.         </tr>

  1919.       </table>

  1920.   </td>

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

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

  1923.   </tr>

  1924. </table>

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

  1926. <p>Print a file's access date</p>

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

  1928.   <table class="params">

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

  1930.   </table>

  1931.   </dd>

  1932. </dl>

  1933. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  1934. 

  1935. </div>

  1936. </div>

  1937. <a id="ab22396a285e27b53501a0047ddd97f59"></a>

  1938. <h2 class="memtitle"><span class="permalink"><a href="#ab22396a285e27b53501a0047ddd97f59">&#9670;&nbsp;</a></span>printCreateDateTime()</h2>

  1939. 

  1940. <div class="memitem">

  1941. <div class="memproto">

  1942.       <table class="memname">

  1943.         <tr>

  1944.           <td class="memname">size_t FatFile::printCreateDateTime </td>

  1945.           <td>(</td>

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

  1947.           <td class="paramname"><em>pr</em></td><td>)</td>

  1948.           <td></td>

  1949.         </tr>

  1950.       </table>

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

  1952. <p>Print a file's creation date and time</p>

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

  1954.   <table class="params">

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

  1956.   </table>

  1957.   </dd>

  1958. </dl>

  1959. <dl class="section return"><dt>Returns</dt><dd>The number of bytes printed. </dd></dl>

  1960. 

  1961. </div>

  1962. </div>

  1963. <a id="aabcd863883bfcfb37b63dbd6021f7eb8"></a>

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

  1974.           <td>(</td>

  1975.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  1976.           <td class="paramname"><em>pr</em>, </td>

  1977.         </tr>

  1978.         <tr>

  1979.           <td class="paramkey"></td>

  1980.           <td></td>

  1981.           <td class="paramtype">uint16_t&#160;</td>

  1982.           <td class="paramname"><em>fatDate</em>&#160;</td>

  1983.         </tr>

  1984.         <tr>

  1985.           <td></td>

  1986.           <td>)</td>

  1987.           <td></td><td></td>

  1988.         </tr>

  1989.       </table>

  1990.   </td>

  1991.   <td class="mlabels-right">

  1992. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  1993.   </tr>

  1994. </table>

  1995. </div><div class="memdoc">

  1996. <p>Print a directory date field.</p>

  1997. <p>Format is yyyy-mm-dd.</p>

  1998. <dl class="params"><dt>Parameters</dt><dd>

  1999.   <table class="params">

  2000.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2001.     <tr><td class="paramdir">[in]</td><td class="paramname">fatDate</td><td>The date field from a directory entry. </td></tr>

  2002.   </table>

  2003.   </dd>

  2004. </dl>

  2005. 

  2006. </div>

  2007. </div>

  2008. <a id="a7f84d953190ea94710dad9ebb897b957"></a>

  2009. <h2 class="memtitle"><span class="permalink"><a href="#a7f84d953190ea94710dad9ebb897b957">&#9670;&nbsp;</a></span>printFatTime()</h2>

  2010. 

  2011. <div class="memitem">

  2012. <div class="memproto">

  2013. <table class="mlabels">

  2014.   <tr>

  2015.   <td class="mlabels-left">

  2016.       <table class="memname">

  2017.         <tr>

  2018.           <td class="memname">static void FatFile::printFatTime </td>

  2019.           <td>(</td>

  2020.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2021.           <td class="paramname"><em>pr</em>, </td>

  2022.         </tr>

  2023.         <tr>

  2024.           <td class="paramkey"></td>

  2025.           <td></td>

  2026.           <td class="paramtype">uint16_t&#160;</td>

  2027.           <td class="paramname"><em>fatTime</em>&#160;</td>

  2028.         </tr>

  2029.         <tr>

  2030.           <td></td>

  2031.           <td>)</td>

  2032.           <td></td><td></td>

  2033.         </tr>

  2034.       </table>

  2035.   </td>

  2036.   <td class="mlabels-right">

  2037. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  2038.   </tr>

  2039. </table>

  2040. </div><div class="memdoc">

  2041. <p>Print a directory time field.</p>

  2042. <p>Format is hh:mm:ss.</p>

  2043. <dl class="params"><dt>Parameters</dt><dd>

  2044.   <table class="params">

  2045.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output. </td></tr>

  2046.     <tr><td class="paramdir">[in]</td><td class="paramname">fatTime</td><td>The time field from a directory entry. </td></tr>

  2047.   </table>

  2048.   </dd>

  2049. </dl>

  2050. 

  2051. </div>

  2052. </div>

  2053. <a id="aa4a61a0cca1813d2ad0f6fe99cc4e41d"></a>

  2054. <h2 class="memtitle"><span class="permalink"><a href="#aa4a61a0cca1813d2ad0f6fe99cc4e41d">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/3]</span></h2>

  2055. 

  2056. <div class="memitem">

  2057. <div class="memproto">

  2058. <table class="mlabels">

  2059.   <tr>

  2060.   <td class="mlabels-left">

  2061.       <table class="memname">

  2062.         <tr>

  2063.           <td class="memname">size_t FatFile::printField </td>

  2064.           <td>(</td>

  2065.           <td class="paramtype">double&#160;</td>

  2066.           <td class="paramname"><em>value</em>, </td>

  2067.         </tr>

  2068.         <tr>

  2069.           <td class="paramkey"></td>

  2070.           <td></td>

  2071.           <td class="paramtype">char&#160;</td>

  2072.           <td class="paramname"><em>term</em>, </td>

  2073.         </tr>

  2074.         <tr>

  2075.           <td class="paramkey"></td>

  2076.           <td></td>

  2077.           <td class="paramtype">uint8_t&#160;</td>

  2078.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2079.         </tr>

  2080.         <tr>

  2081.           <td></td>

  2082.           <td>)</td>

  2083.           <td></td><td></td>

  2084.         </tr>

  2085.       </table>

  2086.   </td>

  2087.   <td class="mlabels-right">

  2088. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2089.   </tr>

  2090. </table>

  2091. </div><div class="memdoc">

  2092. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2093.   <table class="params">

  2094.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2095.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2096.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2097.   </table>

  2098.   </dd>

  2099. </dl>

  2100. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2101. 

  2102. </div>

  2103. </div>

  2104. <a id="a90ccef676afd62bbe7c773dd863a56e0"></a>

  2105. <h2 class="memtitle"><span class="permalink"><a href="#a90ccef676afd62bbe7c773dd863a56e0">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/3]</span></h2>

  2106. 

  2107. <div class="memitem">

  2108. <div class="memproto">

  2109. <table class="mlabels">

  2110.   <tr>

  2111.   <td class="mlabels-left">

  2112.       <table class="memname">

  2113.         <tr>

  2114.           <td class="memname">size_t FatFile::printField </td>

  2115.           <td>(</td>

  2116.           <td class="paramtype">float&#160;</td>

  2117.           <td class="paramname"><em>value</em>, </td>

  2118.         </tr>

  2119.         <tr>

  2120.           <td class="paramkey"></td>

  2121.           <td></td>

  2122.           <td class="paramtype">char&#160;</td>

  2123.           <td class="paramname"><em>term</em>, </td>

  2124.         </tr>

  2125.         <tr>

  2126.           <td class="paramkey"></td>

  2127.           <td></td>

  2128.           <td class="paramtype">uint8_t&#160;</td>

  2129.           <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>

  2130.         </tr>

  2131.         <tr>

  2132.           <td></td>

  2133.           <td>)</td>

  2134.           <td></td><td></td>

  2135.         </tr>

  2136.       </table>

  2137.   </td>

  2138.   <td class="mlabels-right">

  2139. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2140.   </tr>

  2141. </table>

  2142. </div><div class="memdoc">

  2143. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2144.   <table class="params">

  2145.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2146.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2147.     <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>

  2148.   </table>

  2149.   </dd>

  2150. </dl>

  2151. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2152. 

  2153. </div>

  2154. </div>

  2155. <a id="a8f906be79086f38943cb0911310d67bf"></a>

  2156. <h2 class="memtitle"><span class="permalink"><a href="#a8f906be79086f38943cb0911310d67bf">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/3]</span></h2>

  2157. 

  2158. <div class="memitem">

  2159. <div class="memproto">

  2160. <div class="memtemplate">

  2161. template&lt;typename Type &gt; </div>

  2162. <table class="mlabels">

  2163.   <tr>

  2164.   <td class="mlabels-left">

  2165.       <table class="memname">

  2166.         <tr>

  2167.           <td class="memname">size_t FatFile::printField </td>

  2168.           <td>(</td>

  2169.           <td class="paramtype">Type&#160;</td>

  2170.           <td class="paramname"><em>value</em>, </td>

  2171.         </tr>

  2172.         <tr>

  2173.           <td class="paramkey"></td>

  2174.           <td></td>

  2175.           <td class="paramtype">char&#160;</td>

  2176.           <td class="paramname"><em>term</em>&#160;</td>

  2177.         </tr>

  2178.         <tr>

  2179.           <td></td>

  2180.           <td>)</td>

  2181.           <td></td><td></td>

  2182.         </tr>

  2183.       </table>

  2184.   </td>

  2185.   <td class="mlabels-right">

  2186. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2187.   </tr>

  2188. </table>

  2189. </div><div class="memdoc">

  2190. <p>Print a number followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>

  2191.   <table class="params">

  2192.     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The number to be printed. </td></tr>

  2193.     <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>

  2194.   </table>

  2195.   </dd>

  2196. </dl>

  2197. <dl class="section return"><dt>Returns</dt><dd>The number of bytes written or -1 if an error occurs. </dd></dl>

  2198. 

  2199. </div>

  2200. </div>

  2201. <a id="a12a5d2de2737c201aa39ca1bd2ab9c47"></a>

  2202. <h2 class="memtitle"><span class="permalink"><a href="#a12a5d2de2737c201aa39ca1bd2ab9c47">&#9670;&nbsp;</a></span>printFileSize()</h2>

  2203. 

  2204. <div class="memitem">

  2205. <div class="memproto">

  2206.       <table class="memname">

  2207.         <tr>

  2208.           <td class="memname">size_t FatFile::printFileSize </td>

  2209.           <td>(</td>

  2210.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2211.           <td class="paramname"><em>pr</em></td><td>)</td>

  2212.           <td></td>

  2213.         </tr>

  2214.       </table>

  2215. </div><div class="memdoc">

  2216. <p>Print a file's size.</p>

  2217. <dl class="params"><dt>Parameters</dt><dd>

  2218.   <table class="params">

  2219.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2220.   </table>

  2221.   </dd>

  2222. </dl>

  2223. <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>

  2224. 

  2225. </div>

  2226. </div>

  2227. <a id="a43c8a1cabcae673e43c590f5db44c65a"></a>

  2228. <h2 class="memtitle"><span class="permalink"><a href="#a43c8a1cabcae673e43c590f5db44c65a">&#9670;&nbsp;</a></span>printModifyDateTime()</h2>

  2229. 

  2230. <div class="memitem">

  2231. <div class="memproto">

  2232.       <table class="memname">

  2233.         <tr>

  2234.           <td class="memname">size_t FatFile::printModifyDateTime </td>

  2235.           <td>(</td>

  2236.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2237.           <td class="paramname"><em>pr</em></td><td>)</td>

  2238.           <td></td>

  2239.         </tr>

  2240.       </table>

  2241. </div><div class="memdoc">

  2242. <p>Print a file's modify date and time</p>

  2243. <dl class="params"><dt>Parameters</dt><dd>

  2244.   <table class="params">

  2245.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2246.   </table>

  2247.   </dd>

  2248. </dl>

  2249. <dl class="section return"><dt>Returns</dt><dd>The number of characters printed. </dd></dl>

  2250. 

  2251. </div>

  2252. </div>

  2253. <a id="afe18a787fb8640e2d2483370c770f82f"></a>

  2254. <h2 class="memtitle"><span class="permalink"><a href="#afe18a787fb8640e2d2483370c770f82f">&#9670;&nbsp;</a></span>printName()</h2>

  2255. 

  2256. <div class="memitem">

  2257. <div class="memproto">

  2258.       <table class="memname">

  2259.         <tr>

  2260.           <td class="memname">size_t FatFile::printName </td>

  2261.           <td>(</td>

  2262.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2263.           <td class="paramname"><em>pr</em></td><td>)</td>

  2264.           <td></td>

  2265.         </tr>

  2266.       </table>

  2267. </div><div class="memdoc">

  2268. <p>Print a file's name</p>

  2269. <dl class="params"><dt>Parameters</dt><dd>

  2270.   <table class="params">

  2271.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2272.   </table>

  2273.   </dd>

  2274. </dl>

  2275. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2276. 

  2277. </div>

  2278. </div>

  2279. <a id="a791cd7aade71f609aab62ec018aea3c0"></a>

  2280. <h2 class="memtitle"><span class="permalink"><a href="#a791cd7aade71f609aab62ec018aea3c0">&#9670;&nbsp;</a></span>printSFN()</h2>

  2281. 

  2282. <div class="memitem">

  2283. <div class="memproto">

  2284.       <table class="memname">

  2285.         <tr>

  2286.           <td class="memname">size_t FatFile::printSFN </td>

  2287.           <td>(</td>

  2288.           <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>

  2289.           <td class="paramname"><em>pr</em></td><td>)</td>

  2290.           <td></td>

  2291.         </tr>

  2292.       </table>

  2293. </div><div class="memdoc">

  2294. <p>Print a file's Short File Name.</p>

  2295. <dl class="params"><dt>Parameters</dt><dd>

  2296.   <table class="params">

  2297.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for output.</td></tr>

  2298.   </table>

  2299.   </dd>

  2300. </dl>

  2301. <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>

  2302. 

  2303. </div>

  2304. </div>

  2305. <a id="a60ae55ff6fe158c2340071d702a363c5"></a>

  2306. <h2 class="memtitle"><span class="permalink"><a href="#a60ae55ff6fe158c2340071d702a363c5">&#9670;&nbsp;</a></span>read() <span class="overload">[1/2]</span></h2>

  2307. 

  2308. <div class="memitem">

  2309. <div class="memproto">

  2310. <table class="mlabels">

  2311.   <tr>

  2312.   <td class="mlabels-left">

  2313.       <table class="memname">

  2314.         <tr>

  2315.           <td class="memname">int FatFile::read </td>

  2316.           <td>(</td>

  2317.           <td class="paramname"></td><td>)</td>

  2318.           <td></td>

  2319.         </tr>

  2320.       </table>

  2321.   </td>

  2322.   <td class="mlabels-right">

  2323. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2324.   </tr>

  2325. </table>

  2326. </div><div class="memdoc">

  2327. <p>Read the next byte from a file.</p>

  2328. <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>

  2329. 

  2330. </div>

  2331. </div>

  2332. <a id="aba893af8107a18017482d2311b066187"></a>

  2333. <h2 class="memtitle"><span class="permalink"><a href="#aba893af8107a18017482d2311b066187">&#9670;&nbsp;</a></span>read() <span class="overload">[2/2]</span></h2>

  2334. 

  2335. <div class="memitem">

  2336. <div class="memproto">

  2337.       <table class="memname">

  2338.         <tr>

  2339.           <td class="memname">int FatFile::read </td>

  2340.           <td>(</td>

  2341.           <td class="paramtype">void *&#160;</td>

  2342.           <td class="paramname"><em>buf</em>, </td>

  2343.         </tr>

  2344.         <tr>

  2345.           <td class="paramkey"></td>

  2346.           <td></td>

  2347.           <td class="paramtype">size_t&#160;</td>

  2348.           <td class="paramname"><em>count</em>&#160;</td>

  2349.         </tr>

  2350.         <tr>

  2351.           <td></td>

  2352.           <td>)</td>

  2353.           <td></td><td></td>

  2354.         </tr>

  2355.       </table>

  2356. </div><div class="memdoc">

  2357. <p>Read data from a file starting at the current position.</p>

  2358. <dl class="params"><dt>Parameters</dt><dd>

  2359.   <table class="params">

  2360.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Pointer to the location that will receive the data.</td></tr>

  2361.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Maximum number of bytes to read.</td></tr>

  2362.   </table>

  2363.   </dd>

  2364. </dl>

  2365. <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>

  2366. 

  2367. </div>

  2368. </div>

  2369. <a id="a1325afe074c3efecff666678cd9f116a"></a>

  2370. <h2 class="memtitle"><span class="permalink"><a href="#a1325afe074c3efecff666678cd9f116a">&#9670;&nbsp;</a></span>readDir()</h2>

  2371. 

  2372. <div class="memitem">

  2373. <div class="memproto">

  2374.       <table class="memname">

  2375.         <tr>

  2376.           <td class="memname">int8_t FatFile::readDir </td>

  2377.           <td>(</td>

  2378.           <td class="paramtype">dir_t *&#160;</td>

  2379.           <td class="paramname"><em>dir</em></td><td>)</td>

  2380.           <td></td>

  2381.         </tr>

  2382.       </table>

  2383. </div><div class="memdoc">

  2384. <p>Read the next directory entry from a directory file.</p>

  2385. <dl class="params"><dt>Parameters</dt><dd>

  2386.   <table class="params">

  2387.     <tr><td class="paramdir">[out]</td><td class="paramname">dir</td><td>The dir_t struct that will receive the data.</td></tr>

  2388.   </table>

  2389.   </dd>

  2390. </dl>

  2391. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> returns the number of bytes read. A value of zero will be returned if end of file is reached. If an error occurs, <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a1325afe074c3efecff666678cd9f116a">readDir()</a> called before a directory has been opened, this is not a directory file or an I/O error occurred. </dd></dl>

  2392. 

  2393. </div>

  2394. </div>

  2395. <a id="ac837a537fbcca14c7aa390c5fc9f4e7c"></a>

  2396. <h2 class="memtitle"><span class="permalink"><a href="#ac837a537fbcca14c7aa390c5fc9f4e7c">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>

  2397. 

  2398. <div class="memitem">

  2399. <div class="memproto">

  2400.       <table class="memname">

  2401.         <tr>

  2402.           <td class="memname">bool FatFile::remove </td>

  2403.           <td>(</td>

  2404.           <td class="paramname"></td><td>)</td>

  2405.           <td></td>

  2406.         </tr>

  2407.       </table>

  2408. </div><div class="memdoc">

  2409. <p>Remove a file.</p>

  2410. <p>The directory entry and all data for the file are deleted.</p>

  2411. <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>

  2412. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2413. 

  2414. </div>

  2415. </div>

  2416. <a id="a75d3276f0b02b03e863afafe5731fedb"></a>

  2417. <h2 class="memtitle"><span class="permalink"><a href="#a75d3276f0b02b03e863afafe5731fedb">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>

  2418. 

  2419. <div class="memitem">

  2420. <div class="memproto">

  2421.       <table class="memname">

  2422.         <tr>

  2423.           <td class="memname">bool FatFile::remove </td>

  2424.           <td>(</td>

  2425.           <td class="paramtype">const char *&#160;</td>

  2426.           <td class="paramname"><em>path</em></td><td>)</td>

  2427.           <td></td>

  2428.         </tr>

  2429.       </table>

  2430. </div><div class="memdoc">

  2431. <p>Remove a file.</p>

  2432. <p>The directory entry and all data for the file are deleted.</p>

  2433. <dl class="params"><dt>Parameters</dt><dd>

  2434.   <table class="params">

  2435.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for the file to be removed.</td></tr>

  2436.   </table>

  2437.   </dd>

  2438. </dl>

  2439. <p>Example use: dirFile.remove(filenameToRemove);</p>

  2440. <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>

  2441. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2442. 

  2443. </div>

  2444. </div>

  2445. <a id="a4cebcac13c1f4c9de7a055ae73133599"></a>

  2446. <h2 class="memtitle"><span class="permalink"><a href="#a4cebcac13c1f4c9de7a055ae73133599">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>

  2447. 

  2448. <div class="memitem">

  2449. <div class="memproto">

  2450.       <table class="memname">

  2451.         <tr>

  2452.           <td class="memname">bool FatFile::rename </td>

  2453.           <td>(</td>

  2454.           <td class="paramtype">const char *&#160;</td>

  2455.           <td class="paramname"><em>newPath</em></td><td>)</td>

  2456.           <td></td>

  2457.         </tr>

  2458.       </table>

  2459. </div><div class="memdoc">

  2460. <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>

  2461. <dl class="params"><dt>Parameters</dt><dd>

  2462.   <table class="params">

  2463.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2464.   </table>

  2465.   </dd>

  2466. </dl>

  2467. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2468. 

  2469. </div>

  2470. </div>

  2471. <a id="a4b42f2454ff462555c07ea094a92a1e0"></a>

  2472. <h2 class="memtitle"><span class="permalink"><a href="#a4b42f2454ff462555c07ea094a92a1e0">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>

  2473. 

  2474. <div class="memitem">

  2475. <div class="memproto">

  2476.       <table class="memname">

  2477.         <tr>

  2478.           <td class="memname">bool FatFile::rename </td>

  2479.           <td>(</td>

  2480.           <td class="paramtype"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td>

  2481.           <td class="paramname"><em>dirFile</em>, </td>

  2482.         </tr>

  2483.         <tr>

  2484.           <td class="paramkey"></td>

  2485.           <td></td>

  2486.           <td class="paramtype">const char *&#160;</td>

  2487.           <td class="paramname"><em>newPath</em>&#160;</td>

  2488.         </tr>

  2489.         <tr>

  2490.           <td></td>

  2491.           <td>)</td>

  2492.           <td></td><td></td>

  2493.         </tr>

  2494.       </table>

  2495. </div><div class="memdoc">

  2496. <p>Rename a file or subdirectory.</p>

  2497. <dl class="params"><dt>Parameters</dt><dd>

  2498.   <table class="params">

  2499.     <tr><td class="paramdir">[in]</td><td class="paramname">dirFile</td><td>Directory for the new path. </td></tr>

  2500.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name for the file/directory.</td></tr>

  2501.   </table>

  2502.   </dd>

  2503. </dl>

  2504. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2505. 

  2506. </div>

  2507. </div>

  2508. <a id="a5aac6e0b3cb08fc8b8668e916a8b0ca5"></a>

  2509. <h2 class="memtitle"><span class="permalink"><a href="#a5aac6e0b3cb08fc8b8668e916a8b0ca5">&#9670;&nbsp;</a></span>rewind()</h2>

  2510. 

  2511. <div class="memitem">

  2512. <div class="memproto">

  2513. <table class="mlabels">

  2514.   <tr>

  2515.   <td class="mlabels-left">

  2516.       <table class="memname">

  2517.         <tr>

  2518.           <td class="memname">void FatFile::rewind </td>

  2519.           <td>(</td>

  2520.           <td class="paramname"></td><td>)</td>

  2521.           <td></td>

  2522.         </tr>

  2523.       </table>

  2524.   </td>

  2525.   <td class="mlabels-right">

  2526. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2527.   </tr>

  2528. </table>

  2529. </div><div class="memdoc">

  2530. <p>Set the file's current position to zero. </p>

  2531. 

  2532. </div>

  2533. </div>

  2534. <a id="a9515bac181d33e7f0125e88fa2ccd283"></a>

  2535. <h2 class="memtitle"><span class="permalink"><a href="#a9515bac181d33e7f0125e88fa2ccd283">&#9670;&nbsp;</a></span>rmdir()</h2>

  2536. 

  2537. <div class="memitem">

  2538. <div class="memproto">

  2539.       <table class="memname">

  2540.         <tr>

  2541.           <td class="memname">bool FatFile::rmdir </td>

  2542.           <td>(</td>

  2543.           <td class="paramname"></td><td>)</td>

  2544.           <td></td>

  2545.         </tr>

  2546.       </table>

  2547. </div><div class="memdoc">

  2548. <p>Remove a directory file.</p>

  2549. <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>

  2550. <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>

  2551. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2552. 

  2553. </div>

  2554. </div>

  2555. <a id="ac780a80526f86d3def701ecdc99d8bfe"></a>

  2556. <h2 class="memtitle"><span class="permalink"><a href="#ac780a80526f86d3def701ecdc99d8bfe">&#9670;&nbsp;</a></span>rmRfStar()</h2>

  2557. 

  2558. <div class="memitem">

  2559. <div class="memproto">

  2560.       <table class="memname">

  2561.         <tr>

  2562.           <td class="memname">bool FatFile::rmRfStar </td>

  2563.           <td>(</td>

  2564.           <td class="paramname"></td><td>)</td>

  2565.           <td></td>

  2566.         </tr>

  2567.       </table>

  2568. </div><div class="memdoc">

  2569. <p>Recursively delete a directory and all contained files.</p>

  2570. <p>This is like the Unix/Linux 'rm -rf *' if called with the root directory hence the name.</p>

  2571. <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>

  2572. <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>

  2573. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2574. 

  2575. </div>

  2576. </div>

  2577. <a id="a5812037ea30777cc350698ad26f2c73f"></a>

  2578. <h2 class="memtitle"><span class="permalink"><a href="#a5812037ea30777cc350698ad26f2c73f">&#9670;&nbsp;</a></span>seekCur()</h2>

  2579. 

  2580. <div class="memitem">

  2581. <div class="memproto">

  2582. <table class="mlabels">

  2583.   <tr>

  2584.   <td class="mlabels-left">

  2585.       <table class="memname">

  2586.         <tr>

  2587.           <td class="memname">bool FatFile::seekCur </td>

  2588.           <td>(</td>

  2589.           <td class="paramtype">int32_t&#160;</td>

  2590.           <td class="paramname"><em>offset</em></td><td>)</td>

  2591.           <td></td>

  2592.         </tr>

  2593.       </table>

  2594.   </td>

  2595.   <td class="mlabels-right">

  2596. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2597.   </tr>

  2598. </table>

  2599. </div><div class="memdoc">

  2600. <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>

  2601.   <table class="params">

  2602.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from the current position. </td></tr>

  2603.   </table>

  2604.   </dd>

  2605. </dl>

  2606. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2607. 

  2608. </div>

  2609. </div>

  2610. <a id="a84f677f4e75ef6fa2eb632f4cdf6b486"></a>

  2611. <h2 class="memtitle"><span class="permalink"><a href="#a84f677f4e75ef6fa2eb632f4cdf6b486">&#9670;&nbsp;</a></span>seekEnd()</h2>

  2612. 

  2613. <div class="memitem">

  2614. <div class="memproto">

  2615. <table class="mlabels">

  2616.   <tr>

  2617.   <td class="mlabels-left">

  2618.       <table class="memname">

  2619.         <tr>

  2620.           <td class="memname">bool FatFile::seekEnd </td>

  2621.           <td>(</td>

  2622.           <td class="paramtype">int32_t&#160;</td>

  2623.           <td class="paramname"><em>offset</em> = <code>0</code></td><td>)</td>

  2624.           <td></td>

  2625.         </tr>

  2626.       </table>

  2627.   </td>

  2628.   <td class="mlabels-right">

  2629. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2630.   </tr>

  2631. </table>

  2632. </div><div class="memdoc">

  2633. <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>

  2634.   <table class="params">

  2635.     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The new position in bytes from end-of-file. </td></tr>

  2636.   </table>

  2637.   </dd>

  2638. </dl>

  2639. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2640. 

  2641. </div>

  2642. </div>

  2643. <a id="ab067190d25733ed7e697d9890f61fd7a"></a>

  2644. <h2 class="memtitle"><span class="permalink"><a href="#ab067190d25733ed7e697d9890f61fd7a">&#9670;&nbsp;</a></span>seekSet()</h2>

  2645. 

  2646. <div class="memitem">

  2647. <div class="memproto">

  2648.       <table class="memname">

  2649.         <tr>

  2650.           <td class="memname">bool FatFile::seekSet </td>

  2651.           <td>(</td>

  2652.           <td class="paramtype">uint32_t&#160;</td>

  2653.           <td class="paramname"><em>pos</em></td><td>)</td>

  2654.           <td></td>

  2655.         </tr>

  2656.       </table>

  2657. </div><div class="memdoc">

  2658. <p>Sets a file's position.</p>

  2659. <dl class="params"><dt>Parameters</dt><dd>

  2660.   <table class="params">

  2661.     <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>

  2662.   </table>

  2663.   </dd>

  2664. </dl>

  2665. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2666. 

  2667. </div>

  2668. </div>

  2669. <a id="a67f3dc4896c542d695e11aac927f585e"></a>

  2670. <h2 class="memtitle"><span class="permalink"><a href="#a67f3dc4896c542d695e11aac927f585e">&#9670;&nbsp;</a></span>sync()</h2>

  2671. 

  2672. <div class="memitem">

  2673. <div class="memproto">

  2674.       <table class="memname">

  2675.         <tr>

  2676.           <td class="memname">bool FatFile::sync </td>

  2677.           <td>(</td>

  2678.           <td class="paramname"></td><td>)</td>

  2679.           <td></td>

  2680.         </tr>

  2681.       </table>

  2682. </div><div class="memdoc">

  2683. <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>

  2684. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2685. 

  2686. </div>

  2687. </div>

  2688. <a id="a56dabdf73833b7e961c4530eb8e16d23"></a>

  2689. <h2 class="memtitle"><span class="permalink"><a href="#a56dabdf73833b7e961c4530eb8e16d23">&#9670;&nbsp;</a></span>timestamp()</h2>

  2690. 

  2691. <div class="memitem">

  2692. <div class="memproto">

  2693.       <table class="memname">

  2694.         <tr>

  2695.           <td class="memname">bool FatFile::timestamp </td>

  2696.           <td>(</td>

  2697.           <td class="paramtype">uint8_t&#160;</td>

  2698.           <td class="paramname"><em>flags</em>, </td>

  2699.         </tr>

  2700.         <tr>

  2701.           <td class="paramkey"></td>

  2702.           <td></td>

  2703.           <td class="paramtype">uint16_t&#160;</td>

  2704.           <td class="paramname"><em>year</em>, </td>

  2705.         </tr>

  2706.         <tr>

  2707.           <td class="paramkey"></td>

  2708.           <td></td>

  2709.           <td class="paramtype">uint8_t&#160;</td>

  2710.           <td class="paramname"><em>month</em>, </td>

  2711.         </tr>

  2712.         <tr>

  2713.           <td class="paramkey"></td>

  2714.           <td></td>

  2715.           <td class="paramtype">uint8_t&#160;</td>

  2716.           <td class="paramname"><em>day</em>, </td>

  2717.         </tr>

  2718.         <tr>

  2719.           <td class="paramkey"></td>

  2720.           <td></td>

  2721.           <td class="paramtype">uint8_t&#160;</td>

  2722.           <td class="paramname"><em>hour</em>, </td>

  2723.         </tr>

  2724.         <tr>

  2725.           <td class="paramkey"></td>

  2726.           <td></td>

  2727.           <td class="paramtype">uint8_t&#160;</td>

  2728.           <td class="paramname"><em>minute</em>, </td>

  2729.         </tr>

  2730.         <tr>

  2731.           <td class="paramkey"></td>

  2732.           <td></td>

  2733.           <td class="paramtype">uint8_t&#160;</td>

  2734.           <td class="paramname"><em>second</em>&#160;</td>

  2735.         </tr>

  2736.         <tr>

  2737.           <td></td>

  2738.           <td>)</td>

  2739.           <td></td><td></td>

  2740.         </tr>

  2741.       </table>

  2742. </div><div class="memdoc">

  2743. <p>Set a file's timestamps in its directory entry.</p>

  2744. <dl class="params"><dt>Parameters</dt><dd>

  2745.   <table class="params">

  2746.     <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>

  2747.   </table>

  2748.   </dd>

  2749. </dl>

  2750. <p>T_ACCESS - Set the file's last access date.</p>

  2751. <p>T_CREATE - Set the file's creation date and time.</p>

  2752. <p>T_WRITE - Set the file's last write/modification date and time.</p>

  2753. <dl class="params"><dt>Parameters</dt><dd>

  2754.   <table class="params">

  2755.     <tr><td class="paramdir">[in]</td><td class="paramname">year</td><td>Valid range 1980 - 2107 inclusive.</td></tr>

  2756.     <tr><td class="paramdir">[in]</td><td class="paramname">month</td><td>Valid range 1 - 12 inclusive.</td></tr>

  2757.     <tr><td class="paramdir">[in]</td><td class="paramname">day</td><td>Valid range 1 - 31 inclusive.</td></tr>

  2758.     <tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Valid range 0 - 23 inclusive.</td></tr>

  2759.     <tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Valid range 0 - 59 inclusive.</td></tr>

  2760.     <tr><td class="paramdir">[in]</td><td class="paramname">second</td><td>Valid range 0 - 59 inclusive</td></tr>

  2761.   </table>

  2762.   </dd>

  2763. </dl>

  2764. <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>

  2765. <dd>

  2766. Modify and access timestamps may be overwritten if a date time callback function has been set by dateTimeCallback().</dd></dl>

  2767. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2768. 

  2769. </div>

  2770. </div>

  2771. <a id="a7dda881dac19ea2aa9b2e85a229a98d7"></a>

  2772. <h2 class="memtitle"><span class="permalink"><a href="#a7dda881dac19ea2aa9b2e85a229a98d7">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>

  2773. 

  2774. <div class="memitem">

  2775. <div class="memproto">

  2776.       <table class="memname">

  2777.         <tr>

  2778.           <td class="memname">bool FatFile::truncate </td>

  2779.           <td>(</td>

  2780.           <td class="paramname"></td><td>)</td>

  2781.           <td></td>

  2782.         </tr>

  2783.       </table>

  2784. </div><div class="memdoc">

  2785. <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>

  2786. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2787. 

  2788. </div>

  2789. </div>

  2790. <a id="aa6e663098a578635d37d92e82d18d616"></a>

  2791. <h2 class="memtitle"><span class="permalink"><a href="#aa6e663098a578635d37d92e82d18d616">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>

  2792. 

  2793. <div class="memitem">

  2794. <div class="memproto">

  2795. <table class="mlabels">

  2796.   <tr>

  2797.   <td class="mlabels-left">

  2798.       <table class="memname">

  2799.         <tr>

  2800.           <td class="memname">bool FatFile::truncate </td>

  2801.           <td>(</td>

  2802.           <td class="paramtype">uint32_t&#160;</td>

  2803.           <td class="paramname"><em>length</em></td><td>)</td>

  2804.           <td></td>

  2805.         </tr>

  2806.       </table>

  2807.   </td>

  2808.   <td class="mlabels-right">

  2809. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2810.   </tr>

  2811. </table>

  2812. </div><div class="memdoc">

  2813. <p>Truncate a file to a specified length. The current file position will be set to end of file.</p>

  2814. <dl class="params"><dt>Parameters</dt><dd>

  2815.   <table class="params">

  2816.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2817.   </table>

  2818.   </dd>

  2819. </dl>

  2820. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  2821. 

  2822. </div>

  2823. </div>

  2824. <a id="a081dd810835f1ebf8c23ffe92706b485"></a>

  2825. <h2 class="memtitle"><span class="permalink"><a href="#a081dd810835f1ebf8c23ffe92706b485">&#9670;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>

  2826. 

  2827. <div class="memitem">

  2828. <div class="memproto">

  2829. <table class="mlabels">

  2830.   <tr>

  2831.   <td class="mlabels-left">

  2832.       <table class="memname">

  2833.         <tr>

  2834.           <td class="memname">size_t FatFile::write </td>

  2835.           <td>(</td>

  2836.           <td class="paramtype">const char *&#160;</td>

  2837.           <td class="paramname"><em>str</em></td><td>)</td>

  2838.           <td></td>

  2839.         </tr>

  2840.       </table>

  2841.   </td>

  2842.   <td class="mlabels-right">

  2843. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2844.   </tr>

  2845. </table>

  2846. </div><div class="memdoc">

  2847. <p>Write a string to a file. Used by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  2848.   <table class="params">

  2849.     <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer to the string. Use getWriteError to check for errors. </td></tr>

  2850.   </table>

  2851.   </dd>

  2852. </dl>

  2853. <dl class="section return"><dt>Returns</dt><dd>count of characters written for success or -1 for failure. </dd></dl>

  2854. 

  2855. </div>

  2856. </div>

  2857. <a id="ae51e724ac6cc3d67d64a5a666d5850f1"></a>

  2858. <h2 class="memtitle"><span class="permalink"><a href="#ae51e724ac6cc3d67d64a5a666d5850f1">&#9670;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>

  2859. 

  2860. <div class="memitem">

  2861. <div class="memproto">

  2862. <table class="mlabels">

  2863.   <tr>

  2864.   <td class="mlabels-left">

  2865.       <table class="memname">

  2866.         <tr>

  2867.           <td class="memname">size_t FatFile::write </td>

  2868.           <td>(</td>

  2869.           <td class="paramtype">uint8_t&#160;</td>

  2870.           <td class="paramname"><em>b</em></td><td>)</td>

  2871.           <td></td>

  2872.         </tr>

  2873.       </table>

  2874.   </td>

  2875.   <td class="mlabels-right">

  2876. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  2877.   </tr>

  2878. </table>

  2879. </div><div class="memdoc">

  2880. <p>Write a single byte. </p><dl class="params"><dt>Parameters</dt><dd>

  2881.   <table class="params">

  2882.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The byte to be written. </td></tr>

  2883.   </table>

  2884.   </dd>

  2885. </dl>

  2886. <dl class="section return"><dt>Returns</dt><dd>+1 for success or -1 for failure. </dd></dl>

  2887. 

  2888. </div>

  2889. </div>

  2890. <a id="a5d84d871ac904a22aa48308713d14682"></a>

  2891. <h2 class="memtitle"><span class="permalink"><a href="#a5d84d871ac904a22aa48308713d14682">&#9670;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>

  2892. 

  2893. <div class="memitem">

  2894. <div class="memproto">

  2895.       <table class="memname">

  2896.         <tr>

  2897.           <td class="memname">size_t FatFile::write </td>

  2898.           <td>(</td>

  2899.           <td class="paramtype">const void *&#160;</td>

  2900.           <td class="paramname"><em>buf</em>, </td>

  2901.         </tr>

  2902.         <tr>

  2903.           <td class="paramkey"></td>

  2904.           <td></td>

  2905.           <td class="paramtype">size_t&#160;</td>

  2906.           <td class="paramname"><em>count</em>&#160;</td>

  2907.         </tr>

  2908.         <tr>

  2909.           <td></td>

  2910.           <td>)</td>

  2911.           <td></td><td></td>

  2912.         </tr>

  2913.       </table>

  2914. </div><div class="memdoc">

  2915. <p>Write data to an open file.</p>

  2916. <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>

  2917. <dl class="params"><dt>Parameters</dt><dd>

  2918.   <table class="params">

  2919.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the location of the data to be written.</td></tr>

  2920.     <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to write.</td></tr>

  2921.   </table>

  2922.   </dd>

  2923. </dl>

  2924. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write()</a> returns the number of bytes written, always <em>count</em>. If an error occurs, <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">write()</a> returns -1. Possible errors include <a class="el" href="class_fat_file.html#a081dd810835f1ebf8c23ffe92706b485">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>

  2925. 

  2926. </div>

  2927. </div>

  2928. <h2 class="groupheader">Friends And Related Function Documentation</h2>

  2929. <a id="a6ca3f436167f187097347a20ea221555"></a>

  2930. <h2 class="memtitle"><span class="permalink"><a href="#a6ca3f436167f187097347a20ea221555">&#9670;&nbsp;</a></span>FatVolume</h2>

  2931. 

  2932. <div class="memitem">

  2933. <div class="memproto">

  2934. <table class="mlabels">

  2935.   <tr>

  2936.   <td class="mlabels-left">

  2937.       <table class="memname">

  2938.         <tr>

  2939.           <td class="memname">friend class <a class="el" href="class_fat_volume.html">FatVolume</a></td>

  2940.         </tr>

  2941.       </table>

  2942.   </td>

  2943.   <td class="mlabels-right">

  2944. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  2945.   </tr>

  2946. </table>

  2947. </div><div class="memdoc">

  2948. <p><a class="el" href="class_fat_volume.html" title="Integration class for the FatLib library. ">FatVolume</a> allowed access to private members. </p>

  2949. 

  2950. </div>

  2951. </div>

  2952. <hr/>The documentation for this class was generated from the following files:<ul>

  2953. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_8h.html">FatFile.h</a></li>

  2954. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFile.cpp</li>

  2955. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFileLFN.cpp</li>

  2956. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFilePrint.cpp</li>

  2957. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatFileSFN.cpp</li>

  2958. </ul>

  2959. </div><!-- contents -->

  2960. <!-- start footer part -->

  2961. <hr class="footer"/><address class="footer"><small>

  2962. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2963. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2964. </a> 1.8.14

  2965. </small></address>

  2966. </body>

  2967. </html>