您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

1338 行
58KB

  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.10"/>
  7. <title>SdFat: FatFileSystem Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">SdFat
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  65. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#pub-methods">Public Member Functions</a> &#124;
  84. <a href="class_fat_file_system-members.html">List of all members</a> </div>
  85. <div class="headertitle">
  86. <div class="title">FatFileSystem Class Reference</div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <p>Integration class for the FatLib library.
  90. <a href="class_fat_file_system.html#details">More...</a></p>
  91. <p><code>#include &lt;FatFileSystem.h&gt;</code></p>
  92. <div class="dynheader">
  93. Inheritance diagram for FatFileSystem:</div>
  94. <div class="dyncontent">
  95. <div class="center"><img src="class_fat_file_system__inherit__graph.png" border="0" usemap="#_fat_file_system_inherit__map" alt="Inheritance graph"/></div>
  96. <map name="_fat_file_system_inherit__map" id="_fat_file_system_inherit__map">
  97. <area shape="rect" id="node3" href="class_sd_file_system.html" title="Virtual base class for SdFat library. " alt="" coords="301,13,511,40"/>
  98. <area shape="rect" id="node4" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdBlockDriver \&gt;" alt="" coords="301,64,511,91"/>
  99. <area shape="rect" id="node7" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdBlockDriverEX \&gt;" alt="" coords="293,123,519,149"/>
  100. <area shape="rect" id="node2" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="5,64,91,91"/>
  101. <area shape="rect" id="node5" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="627,5,685,32"/>
  102. <area shape="rect" id="node6" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="575,57,737,98"/>
  103. <area shape="rect" id="node8" href="class_sd_fat_e_x.html" title="SdFat class with extended SD I/O. " alt="" coords="619,123,693,149"/>
  104. <area shape="rect" id="node9" href="class_sd_fat_soft_spi_e_x.html" title="SdFat class using software SPI and extended SD I/O. " alt="" coords="567,174,745,215"/>
  105. </map>
  106. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  107. <div class="dynheader">
  108. Collaboration diagram for FatFileSystem:</div>
  109. <div class="dyncontent">
  110. <div class="center"><img src="class_fat_file_system__coll__graph.png" border="0" usemap="#_fat_file_system_coll__map" alt="Collaboration graph"/></div>
  111. <map name="_fat_file_system_coll__map" id="_fat_file_system_coll__map">
  112. <area shape="rect" id="node2" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="16,5,101,32"/>
  113. </map>
  114. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  115. <table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  117. Public Member Functions</h2></td></tr>
  118. <tr class="memitem:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5dda20d3dcbfc8c641babbb2c9aac382">begin</a> (<a class="el" href="_block_driver_8h.html#a29e32edf30724992d0ab870a56fdde6c">BlockDriver</a> *blockDev, uint8_t part=0)</td></tr>
  119. <tr class="separator:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a06beed4cea5e38116b58254a57125442"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a06beed4cea5e38116b58254a57125442">blocksPerCluster</a> () const </td></tr>
  121. <tr class="separator:a06beed4cea5e38116b58254a57125442"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:abc66d856d05198d9ebe7104c8c4155d7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#abc66d856d05198d9ebe7104c8c4155d7">blocksPerFat</a> () const </td></tr>
  123. <tr class="separator:abc66d856d05198d9ebe7104c8c4155d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioncache__t.html">cache_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#aa1e3b1d0c21d202deb82668068ab00e8">cacheClear</a> ()</td></tr>
  125. <tr class="separator:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a5667915e63187a43a71dfada63800865"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5667915e63187a43a71dfada63800865">chdir</a> (bool set_cwd=false)</td></tr>
  127. <tr class="separator:a5667915e63187a43a71dfada63800865"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a44af1b98e8d986d12107b654453acbc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a44af1b98e8d986d12107b654453acbc4">chdir</a> (const char *path, bool set_cwd=false)</td></tr>
  129. <tr class="separator:a44af1b98e8d986d12107b654453acbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:af24917d6e00c8766dab168eb834047ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#af24917d6e00c8766dab168eb834047ec">chvol</a> ()</td></tr>
  131. <tr class="separator:af24917d6e00c8766dab168eb834047ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a18446a9c5924304fa7a87d5f03ccaf21">clusterCount</a> () const </td></tr>
  133. <tr class="separator:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ac0e63f33d71d5dc95a602834274def6a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac0e63f33d71d5dc95a602834274def6a">clusterSizeShift</a> () const </td></tr>
  135. <tr class="separator:ac0e63f33d71d5dc95a602834274def6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a443364af257c219f8e908d5b073d8fa3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a443364af257c219f8e908d5b073d8fa3">dataStartBlock</a> () const </td></tr>
  137. <tr class="separator:a443364af257c219f8e908d5b073d8fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a25c6311b70fa274b3be94ff25fdebba7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a25c6311b70fa274b3be94ff25fdebba7">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  139. <tr class="separator:a25c6311b70fa274b3be94ff25fdebba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aee58c6352652f216577196e32a594b67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aee58c6352652f216577196e32a594b67">exists</a> (const char *path)</td></tr>
  141. <tr class="separator:aee58c6352652f216577196e32a594b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acdedc6a200b01e401c9cd9b511eae6ec">fatCount</a> ()</td></tr>
  143. <tr class="separator:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a0dd0cc689b63ef0702aed1cf36b1722d">fatStartBlock</a> () const </td></tr>
  145. <tr class="separator:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1364f11fe9bb4717ce0685e2b7b86027">fatType</a> () const </td></tr>
  147. <tr class="separator:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a1683b063fc6202ab85470b9610f16f93"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1683b063fc6202ab85470b9610f16f93">freeClusterCount</a> ()</td></tr>
  149. <tr class="separator:a1683b063fc6202ab85470b9610f16f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">init</a> ()</td></tr>
  151. <tr class="separator:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a034d997a1e7a0b2b664a4357bcccd256"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a034d997a1e7a0b2b664a4357bcccd256">init</a> (uint8_t part)</td></tr>
  153. <tr class="separator:a034d997a1e7a0b2b664a4357bcccd256"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a2398fb37a7a9d5e0dc0ffde6a44a993d">ls</a> (uint8_t flags=0)</td></tr>
  155. <tr class="separator:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a122b61dbec5051304bcc81bc08b1b99d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a122b61dbec5051304bcc81bc08b1b99d">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  157. <tr class="separator:a122b61dbec5051304bcc81bc08b1b99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ae12fb8bfad5c4a8e052dda70a5a0ed93">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>
  159. <tr class="separator:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:aa79695db8e910300507210b3067d39fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aa79695db8e910300507210b3067d39fd">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  161. <tr class="separator:aa79695db8e910300507210b3067d39fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a231c62c98ba8ac3c2624dc5ad2053ebf">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  163. <tr class="separator:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a947e4586077a922892b632edac33b67a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a947e4586077a922892b632edac33b67a">open</a> (const char *path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  165. <tr class="separator:a947e4586077a922892b632edac33b67a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0abfb1f754a8fb559cfa884ee040f56f">open</a> (const String &amp;path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  167. <tr class="separator:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#abf7d7d0dab43083d5be10d70ff4669e4">remove</a> (const char *path)</td></tr>
  169. <tr class="separator:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a0187891a24017b41bd7c5ba63e659e65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  171. <tr class="separator:a0187891a24017b41bd7c5ba63e659e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:aaed2edc7ff7fedb163458c870bb41b33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aaed2edc7ff7fedb163458c870bb41b33">rmdir</a> (const char *path)</td></tr>
  173. <tr class="separator:aaed2edc7ff7fedb163458c870bb41b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab2d483670a0a6a6a4754b23614fe11bc">rootDirEntryCount</a> () const </td></tr>
  175. <tr class="separator:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae9363ebbbae90e895ea56e8fa3f60c13">rootDirStart</a> () const </td></tr>
  177. <tr class="separator:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:ad60cb13557f35578f868e03e9ccb8be1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ad60cb13557f35578f868e03e9ccb8be1">truncate</a> (const char *path, uint32_t length)</td></tr>
  179. <tr class="separator:ad60cb13557f35578f868e03e9ccb8be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a4ca68fe47bb675df0a80df1ed7a53698">vol</a> ()</td></tr>
  181. <tr class="separator:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a07bc98088ce4a9c725700899c184f7fc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a07bc98088ce4a9c725700899c184f7fc">volumeBlockCount</a> () const </td></tr>
  183. <tr class="separator:a07bc98088ce4a9c725700899c184f7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:acf257d02b7166683bda2abc5058004bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#acf257d02b7166683bda2abc5058004bf">vwd</a> ()</td></tr>
  185. <tr class="separator:acf257d02b7166683bda2abc5058004bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a36d7831f92acfbfef1c4a24dd7103dc4">wipe</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=0)</td></tr>
  187. <tr class="separator:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. </table>
  189. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  190. <div class="textblock"><p>Integration class for the FatLib library. </p>
  191. </div><h2 class="groupheader">Member Function Documentation</h2>
  192. <a class="anchor" id="a5dda20d3dcbfc8c641babbb2c9aac382"></a>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="mlabels">
  196. <tr>
  197. <td class="mlabels-left">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">bool FatFileSystem::begin </td>
  201. <td>(</td>
  202. <td class="paramtype"><a class="el" href="_block_driver_8h.html#a29e32edf30724992d0ab870a56fdde6c">BlockDriver</a> *&#160;</td>
  203. <td class="paramname"><em>blockDev</em>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype">uint8_t&#160;</td>
  209. <td class="paramname"><em>part</em> = <code>0</code>&#160;</td>
  210. </tr>
  211. <tr>
  212. <td></td>
  213. <td>)</td>
  214. <td></td><td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Initialize an <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> object. </p><dl class="params"><dt>Parameters</dt><dd>
  224. <table class="params">
  225. <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>
  226. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>
  227. </table>
  228. </dd>
  229. </dl>
  230. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  231. </div>
  232. </div>
  233. <a class="anchor" id="a06beed4cea5e38116b58254a57125442"></a>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="mlabels">
  237. <tr>
  238. <td class="mlabels-left">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname">uint8_t FatVolume::blocksPerCluster </td>
  242. <td>(</td>
  243. <td class="paramname"></td><td>)</td>
  244. <td> const</td>
  245. </tr>
  246. </table>
  247. </td>
  248. <td class="mlabels-right">
  249. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>
  254. </div>
  255. </div>
  256. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></a>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="mlabels">
  260. <tr>
  261. <td class="mlabels-left">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">uint32_t FatVolume::blocksPerFat </td>
  265. <td>(</td>
  266. <td class="paramname"></td><td>)</td>
  267. <td> const</td>
  268. </tr>
  269. </table>
  270. </td>
  271. <td class="mlabels-right">
  272. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  277. </div>
  278. </div>
  279. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></a>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>
  288. <td>(</td>
  289. <td class="paramname"></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Clear the cache and returns a pointer to the cache. Not for normal apps. </p><dl class="section return"><dt>Returns</dt><dd>A pointer to the cache buffer or zero if an error occurs. </dd></dl>
  300. </div>
  301. </div>
  302. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></a>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="mlabels">
  306. <tr>
  307. <td class="mlabels-left">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">bool FatFileSystem::chdir </td>
  311. <td>(</td>
  312. <td class="paramtype">bool&#160;</td>
  313. <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>
  314. <td></td>
  315. </tr>
  316. </table>
  317. </td>
  318. <td class="mlabels-right">
  319. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Change a volume's working directory to root</p>
  324. <p>Changes the volume's working directory to the SD's root directory. Optionally set the current working directory to the volume's working directory.</p>
  325. <dl class="params"><dt>Parameters</dt><dd>
  326. <table class="params">
  327. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  328. </table>
  329. </dd>
  330. </dl>
  331. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  332. </div>
  333. </div>
  334. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></a>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="mlabels">
  338. <tr>
  339. <td class="mlabels-left">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname">bool FatFileSystem::chdir </td>
  343. <td>(</td>
  344. <td class="paramtype">const char *&#160;</td>
  345. <td class="paramname"><em>path</em>, </td>
  346. </tr>
  347. <tr>
  348. <td class="paramkey"></td>
  349. <td></td>
  350. <td class="paramtype">bool&#160;</td>
  351. <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>
  352. </tr>
  353. <tr>
  354. <td></td>
  355. <td>)</td>
  356. <td></td><td></td>
  357. </tr>
  358. </table>
  359. </td>
  360. <td class="mlabels-right">
  361. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <p>Change a volume's working directory</p>
  366. <p>Changes the volume working directory to the <em>path</em> subdirectory. Optionally set the current working directory to the volume's working directory.</p>
  367. <p>Example: If the volume's working directory is "/DIR", chdir("SUB") will change the volume's working directory from "/DIR" to "/DIR/SUB".</p>
  368. <p>If path is "/", the volume's working directory will be changed to the root directory</p>
  369. <dl class="params"><dt>Parameters</dt><dd>
  370. <table class="params">
  371. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>
  372. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  373. </table>
  374. </dd>
  375. </dl>
  376. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  377. </div>
  378. </div>
  379. <a class="anchor" id="af24917d6e00c8766dab168eb834047ec"></a>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="mlabels">
  383. <tr>
  384. <td class="mlabels-left">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname">void FatFileSystem::chvol </td>
  388. <td>(</td>
  389. <td class="paramname"></td><td>)</td>
  390. <td></td>
  391. </tr>
  392. </table>
  393. </td>
  394. <td class="mlabels-right">
  395. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Set the current working directory to a volume's working directory.</p>
  400. <p>This is useful with multiple SD cards.</p>
  401. <p>The current working directory is changed to this volume's working directory.</p>
  402. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>
  403. </div>
  404. </div>
  405. <a class="anchor" id="a18446a9c5924304fa7a87d5f03ccaf21"></a>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <table class="mlabels">
  409. <tr>
  410. <td class="mlabels-left">
  411. <table class="memname">
  412. <tr>
  413. <td class="memname">uint32_t FatVolume::clusterCount </td>
  414. <td>(</td>
  415. <td class="paramname"></td><td>)</td>
  416. <td> const</td>
  417. </tr>
  418. </table>
  419. </td>
  420. <td class="mlabels-right">
  421. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  422. </tr>
  423. </table>
  424. </div><div class="memdoc">
  425. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  426. </div>
  427. </div>
  428. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></a>
  429. <div class="memitem">
  430. <div class="memproto">
  431. <table class="mlabels">
  432. <tr>
  433. <td class="mlabels-left">
  434. <table class="memname">
  435. <tr>
  436. <td class="memname">uint8_t FatVolume::clusterSizeShift </td>
  437. <td>(</td>
  438. <td class="paramname"></td><td>)</td>
  439. <td> const</td>
  440. </tr>
  441. </table>
  442. </td>
  443. <td class="mlabels-right">
  444. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  445. </tr>
  446. </table>
  447. </div><div class="memdoc">
  448. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>
  449. </div>
  450. </div>
  451. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></a>
  452. <div class="memitem">
  453. <div class="memproto">
  454. <table class="mlabels">
  455. <tr>
  456. <td class="mlabels-left">
  457. <table class="memname">
  458. <tr>
  459. <td class="memname">uint32_t FatVolume::dataStartBlock </td>
  460. <td>(</td>
  461. <td class="paramname"></td><td>)</td>
  462. <td> const</td>
  463. </tr>
  464. </table>
  465. </td>
  466. <td class="mlabels-right">
  467. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  468. </tr>
  469. </table>
  470. </div><div class="memdoc">
  471. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  472. </div>
  473. </div>
  474. <a class="anchor" id="a25c6311b70fa274b3be94ff25fdebba7"></a>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="mlabels">
  478. <tr>
  479. <td class="mlabels-left">
  480. <table class="memname">
  481. <tr>
  482. <td class="memname">int8_t FatVolume::dbgFat </td>
  483. <td>(</td>
  484. <td class="paramtype">uint32_t&#160;</td>
  485. <td class="paramname"><em>n</em>, </td>
  486. </tr>
  487. <tr>
  488. <td class="paramkey"></td>
  489. <td></td>
  490. <td class="paramtype">uint32_t *&#160;</td>
  491. <td class="paramname"><em>v</em>&#160;</td>
  492. </tr>
  493. <tr>
  494. <td></td>
  495. <td>)</td>
  496. <td></td><td></td>
  497. </tr>
  498. </table>
  499. </td>
  500. <td class="mlabels-right">
  501. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  502. </tr>
  503. </table>
  504. </div><div class="memdoc">
  505. <p>Debug access to FAT table</p>
  506. <dl class="params"><dt>Parameters</dt><dd>
  507. <table class="params">
  508. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  509. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  510. </table>
  511. </dd>
  512. </dl>
  513. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>
  514. </div>
  515. </div>
  516. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></a>
  517. <div class="memitem">
  518. <div class="memproto">
  519. <table class="mlabels">
  520. <tr>
  521. <td class="mlabels-left">
  522. <table class="memname">
  523. <tr>
  524. <td class="memname">bool FatFileSystem::exists </td>
  525. <td>(</td>
  526. <td class="paramtype">const char *&#160;</td>
  527. <td class="paramname"><em>path</em></td><td>)</td>
  528. <td></td>
  529. </tr>
  530. </table>
  531. </td>
  532. <td class="mlabels-right">
  533. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  534. </tr>
  535. </table>
  536. </div><div class="memdoc">
  537. <p>Test for the existence of a file.</p>
  538. <dl class="params"><dt>Parameters</dt><dd>
  539. <table class="params">
  540. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  541. </table>
  542. </dd>
  543. </dl>
  544. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  545. </div>
  546. </div>
  547. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></a>
  548. <div class="memitem">
  549. <div class="memproto">
  550. <table class="mlabels">
  551. <tr>
  552. <td class="mlabels-left">
  553. <table class="memname">
  554. <tr>
  555. <td class="memname">uint8_t FatVolume::fatCount </td>
  556. <td>(</td>
  557. <td class="paramname"></td><td>)</td>
  558. <td></td>
  559. </tr>
  560. </table>
  561. </td>
  562. <td class="mlabels-right">
  563. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  564. </tr>
  565. </table>
  566. </div><div class="memdoc">
  567. <dl class="section return"><dt>Returns</dt><dd>The number of <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Allocation Tables. </dd></dl>
  568. </div>
  569. </div>
  570. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></a>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="mlabels">
  574. <tr>
  575. <td class="mlabels-left">
  576. <table class="memname">
  577. <tr>
  578. <td class="memname">uint32_t FatVolume::fatStartBlock </td>
  579. <td>(</td>
  580. <td class="paramname"></td><td>)</td>
  581. <td> const</td>
  582. </tr>
  583. </table>
  584. </td>
  585. <td class="mlabels-right">
  586. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  591. </div>
  592. </div>
  593. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></a>
  594. <div class="memitem">
  595. <div class="memproto">
  596. <table class="mlabels">
  597. <tr>
  598. <td class="mlabels-left">
  599. <table class="memname">
  600. <tr>
  601. <td class="memname">uint8_t FatVolume::fatType </td>
  602. <td>(</td>
  603. <td class="paramname"></td><td>)</td>
  604. <td> const</td>
  605. </tr>
  606. </table>
  607. </td>
  608. <td class="mlabels-right">
  609. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  610. </tr>
  611. </table>
  612. </div><div class="memdoc">
  613. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  614. </div>
  615. </div>
  616. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></a>
  617. <div class="memitem">
  618. <div class="memproto">
  619. <table class="mlabels">
  620. <tr>
  621. <td class="mlabels-left">
  622. <table class="memname">
  623. <tr>
  624. <td class="memname">int32_t FatVolume::freeClusterCount </td>
  625. <td>(</td>
  626. <td class="paramname"></td><td>)</td>
  627. <td></td>
  628. </tr>
  629. </table>
  630. </td>
  631. <td class="mlabels-right">
  632. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  633. </tr>
  634. </table>
  635. </div><div class="memdoc">
  636. <p>Volume free space in clusters.</p>
  637. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  638. </div>
  639. </div>
  640. <a class="anchor" id="acab819fa25a91dad1cc698a7e1e0eb32"></a>
  641. <div class="memitem">
  642. <div class="memproto">
  643. <table class="mlabels">
  644. <tr>
  645. <td class="mlabels-left">
  646. <table class="memname">
  647. <tr>
  648. <td class="memname">bool FatVolume::init </td>
  649. <td>(</td>
  650. <td class="paramname"></td><td>)</td>
  651. <td></td>
  652. </tr>
  653. </table>
  654. </td>
  655. <td class="mlabels-right">
  656. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  657. </tr>
  658. </table>
  659. </div><div class="memdoc">
  660. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  661. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  662. </div>
  663. </div>
  664. <a class="anchor" id="a034d997a1e7a0b2b664a4357bcccd256"></a>
  665. <div class="memitem">
  666. <div class="memproto">
  667. <table class="mlabels">
  668. <tr>
  669. <td class="mlabels-left">
  670. <table class="memname">
  671. <tr>
  672. <td class="memname">bool FatVolume::init </td>
  673. <td>(</td>
  674. <td class="paramtype">uint8_t&#160;</td>
  675. <td class="paramname"><em>part</em></td><td>)</td>
  676. <td></td>
  677. </tr>
  678. </table>
  679. </td>
  680. <td class="mlabels-right">
  681. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  682. </tr>
  683. </table>
  684. </div><div class="memdoc">
  685. <p>Initialize a FAT volume.</p>
  686. <dl class="params"><dt>Parameters</dt><dd>
  687. <table class="params">
  688. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>The partition to be used. Legal values for <em>part</em> are 1-4 to use the corresponding partition on a device formatted with a MBR, Master Boot Record, or zero if the device is formatted as a super floppy with the FAT boot sector in block zero.</td></tr>
  689. </table>
  690. </dd>
  691. </dl>
  692. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  693. </div>
  694. </div>
  695. <a class="anchor" id="a2398fb37a7a9d5e0dc0ffde6a44a993d"></a>
  696. <div class="memitem">
  697. <div class="memproto">
  698. <table class="mlabels">
  699. <tr>
  700. <td class="mlabels-left">
  701. <table class="memname">
  702. <tr>
  703. <td class="memname">void FatFileSystem::ls </td>
  704. <td>(</td>
  705. <td class="paramtype">uint8_t&#160;</td>
  706. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  707. <td></td>
  708. </tr>
  709. </table>
  710. </td>
  711. <td class="mlabels-right">
  712. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  713. </tr>
  714. </table>
  715. </div><div class="memdoc">
  716. <p>List the directory contents of the volume working directory to Serial.</p>
  717. <dl class="params"><dt>Parameters</dt><dd>
  718. <table class="params">
  719. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  720. </table>
  721. </dd>
  722. </dl>
  723. <p>LS_DATE - Print file modification date</p>
  724. <p>LS_SIZE - Print file size.</p>
  725. <p>LS_R - Recursive list of subdirectories. </p>
  726. </div>
  727. </div>
  728. <a class="anchor" id="a122b61dbec5051304bcc81bc08b1b99d"></a>
  729. <div class="memitem">
  730. <div class="memproto">
  731. <table class="mlabels">
  732. <tr>
  733. <td class="mlabels-left">
  734. <table class="memname">
  735. <tr>
  736. <td class="memname">void FatFileSystem::ls </td>
  737. <td>(</td>
  738. <td class="paramtype">const char *&#160;</td>
  739. <td class="paramname"><em>path</em>, </td>
  740. </tr>
  741. <tr>
  742. <td class="paramkey"></td>
  743. <td></td>
  744. <td class="paramtype">uint8_t&#160;</td>
  745. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  746. </tr>
  747. <tr>
  748. <td></td>
  749. <td>)</td>
  750. <td></td><td></td>
  751. </tr>
  752. </table>
  753. </td>
  754. <td class="mlabels-right">
  755. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  756. </tr>
  757. </table>
  758. </div><div class="memdoc">
  759. <p>List the directory contents of a directory to Serial.</p>
  760. <dl class="params"><dt>Parameters</dt><dd>
  761. <table class="params">
  762. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  763. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  764. </table>
  765. </dd>
  766. </dl>
  767. <p>LS_DATE - Print file modification date</p>
  768. <p>LS_SIZE - Print file size.</p>
  769. <p>LS_R - Recursive list of subdirectories. </p>
  770. </div>
  771. </div>
  772. <a class="anchor" id="ae12fb8bfad5c4a8e052dda70a5a0ed93"></a>
  773. <div class="memitem">
  774. <div class="memproto">
  775. <table class="mlabels">
  776. <tr>
  777. <td class="mlabels-left">
  778. <table class="memname">
  779. <tr>
  780. <td class="memname">void FatFileSystem::ls </td>
  781. <td>(</td>
  782. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  783. <td class="paramname"><em>pr</em>, </td>
  784. </tr>
  785. <tr>
  786. <td class="paramkey"></td>
  787. <td></td>
  788. <td class="paramtype">uint8_t&#160;</td>
  789. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  790. </tr>
  791. <tr>
  792. <td></td>
  793. <td>)</td>
  794. <td></td><td></td>
  795. </tr>
  796. </table>
  797. </td>
  798. <td class="mlabels-right">
  799. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  800. </tr>
  801. </table>
  802. </div><div class="memdoc">
  803. <p>List the directory contents of the volume working directory.</p>
  804. <dl class="params"><dt>Parameters</dt><dd>
  805. <table class="params">
  806. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  807. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  808. </table>
  809. </dd>
  810. </dl>
  811. <p>LS_DATE - Print file modification date</p>
  812. <p>LS_SIZE - Print file size.</p>
  813. <p>LS_R - Recursive list of subdirectories. </p>
  814. </div>
  815. </div>
  816. <a class="anchor" id="aa79695db8e910300507210b3067d39fd"></a>
  817. <div class="memitem">
  818. <div class="memproto">
  819. <table class="mlabels">
  820. <tr>
  821. <td class="mlabels-left">
  822. <table class="memname">
  823. <tr>
  824. <td class="memname">void FatFileSystem::ls </td>
  825. <td>(</td>
  826. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  827. <td class="paramname"><em>pr</em>, </td>
  828. </tr>
  829. <tr>
  830. <td class="paramkey"></td>
  831. <td></td>
  832. <td class="paramtype">const char *&#160;</td>
  833. <td class="paramname"><em>path</em>, </td>
  834. </tr>
  835. <tr>
  836. <td class="paramkey"></td>
  837. <td></td>
  838. <td class="paramtype">uint8_t&#160;</td>
  839. <td class="paramname"><em>flags</em>&#160;</td>
  840. </tr>
  841. <tr>
  842. <td></td>
  843. <td>)</td>
  844. <td></td><td></td>
  845. </tr>
  846. </table>
  847. </td>
  848. <td class="mlabels-right">
  849. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  850. </tr>
  851. </table>
  852. </div><div class="memdoc">
  853. <p>List the directory contents of a directory.</p>
  854. <dl class="params"><dt>Parameters</dt><dd>
  855. <table class="params">
  856. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  857. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  858. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  859. </table>
  860. </dd>
  861. </dl>
  862. <p>LS_DATE - Print file modification date</p>
  863. <p>LS_SIZE - Print file size.</p>
  864. <p>LS_R - Recursive list of subdirectories. </p>
  865. </div>
  866. </div>
  867. <a class="anchor" id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>
  868. <div class="memitem">
  869. <div class="memproto">
  870. <table class="mlabels">
  871. <tr>
  872. <td class="mlabels-left">
  873. <table class="memname">
  874. <tr>
  875. <td class="memname">bool FatFileSystem::mkdir </td>
  876. <td>(</td>
  877. <td class="paramtype">const char *&#160;</td>
  878. <td class="paramname"><em>path</em>, </td>
  879. </tr>
  880. <tr>
  881. <td class="paramkey"></td>
  882. <td></td>
  883. <td class="paramtype">bool&#160;</td>
  884. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  885. </tr>
  886. <tr>
  887. <td></td>
  888. <td>)</td>
  889. <td></td><td></td>
  890. </tr>
  891. </table>
  892. </td>
  893. <td class="mlabels-right">
  894. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  895. </tr>
  896. </table>
  897. </div><div class="memdoc">
  898. <p>Make a subdirectory in the volume working directory.</p>
  899. <dl class="params"><dt>Parameters</dt><dd>
  900. <table class="params">
  901. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  902. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  903. </table>
  904. </dd>
  905. </dl>
  906. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  907. </div>
  908. </div>
  909. <a class="anchor" id="a947e4586077a922892b632edac33b67a"></a>
  910. <div class="memitem">
  911. <div class="memproto">
  912. <table class="mlabels">
  913. <tr>
  914. <td class="mlabels-left">
  915. <table class="memname">
  916. <tr>
  917. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  918. <td>(</td>
  919. <td class="paramtype">const char *&#160;</td>
  920. <td class="paramname"><em>path</em>, </td>
  921. </tr>
  922. <tr>
  923. <td class="paramkey"></td>
  924. <td></td>
  925. <td class="paramtype">uint8_t&#160;</td>
  926. <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  927. </tr>
  928. <tr>
  929. <td></td>
  930. <td>)</td>
  931. <td></td><td></td>
  932. </tr>
  933. </table>
  934. </td>
  935. <td class="mlabels-right">
  936. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  937. </tr>
  938. </table>
  939. </div><div class="memdoc">
  940. <p>open a file</p>
  941. <dl class="params"><dt>Parameters</dt><dd>
  942. <table class="params">
  943. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  944. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  945. </table>
  946. </dd>
  947. </dl>
  948. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  949. </div>
  950. </div>
  951. <a class="anchor" id="a0abfb1f754a8fb559cfa884ee040f56f"></a>
  952. <div class="memitem">
  953. <div class="memproto">
  954. <table class="mlabels">
  955. <tr>
  956. <td class="mlabels-left">
  957. <table class="memname">
  958. <tr>
  959. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  960. <td>(</td>
  961. <td class="paramtype">const String &amp;&#160;</td>
  962. <td class="paramname"><em>path</em>, </td>
  963. </tr>
  964. <tr>
  965. <td class="paramkey"></td>
  966. <td></td>
  967. <td class="paramtype">uint8_t&#160;</td>
  968. <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  969. </tr>
  970. <tr>
  971. <td></td>
  972. <td>)</td>
  973. <td></td><td></td>
  974. </tr>
  975. </table>
  976. </td>
  977. <td class="mlabels-right">
  978. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  979. </tr>
  980. </table>
  981. </div><div class="memdoc">
  982. <p>open a file</p>
  983. <dl class="params"><dt>Parameters</dt><dd>
  984. <table class="params">
  985. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  986. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  987. </table>
  988. </dd>
  989. </dl>
  990. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  991. </div>
  992. </div>
  993. <a class="anchor" id="abf7d7d0dab43083d5be10d70ff4669e4"></a>
  994. <div class="memitem">
  995. <div class="memproto">
  996. <table class="mlabels">
  997. <tr>
  998. <td class="mlabels-left">
  999. <table class="memname">
  1000. <tr>
  1001. <td class="memname">bool FatFileSystem::remove </td>
  1002. <td>(</td>
  1003. <td class="paramtype">const char *&#160;</td>
  1004. <td class="paramname"><em>path</em></td><td>)</td>
  1005. <td></td>
  1006. </tr>
  1007. </table>
  1008. </td>
  1009. <td class="mlabels-right">
  1010. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1011. </tr>
  1012. </table>
  1013. </div><div class="memdoc">
  1014. <p>Remove a file from the volume working directory.</p>
  1015. <dl class="params"><dt>Parameters</dt><dd>
  1016. <table class="params">
  1017. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the file.</td></tr>
  1018. </table>
  1019. </dd>
  1020. </dl>
  1021. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1022. </div>
  1023. </div>
  1024. <a class="anchor" id="a0187891a24017b41bd7c5ba63e659e65"></a>
  1025. <div class="memitem">
  1026. <div class="memproto">
  1027. <table class="mlabels">
  1028. <tr>
  1029. <td class="mlabels-left">
  1030. <table class="memname">
  1031. <tr>
  1032. <td class="memname">bool FatFileSystem::rename </td>
  1033. <td>(</td>
  1034. <td class="paramtype">const char *&#160;</td>
  1035. <td class="paramname"><em>oldPath</em>, </td>
  1036. </tr>
  1037. <tr>
  1038. <td class="paramkey"></td>
  1039. <td></td>
  1040. <td class="paramtype">const char *&#160;</td>
  1041. <td class="paramname"><em>newPath</em>&#160;</td>
  1042. </tr>
  1043. <tr>
  1044. <td></td>
  1045. <td>)</td>
  1046. <td></td><td></td>
  1047. </tr>
  1048. </table>
  1049. </td>
  1050. <td class="mlabels-right">
  1051. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1052. </tr>
  1053. </table>
  1054. </div><div class="memdoc">
  1055. <p>Rename a file or subdirectory.</p>
  1056. <dl class="params"><dt>Parameters</dt><dd>
  1057. <table class="params">
  1058. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1059. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1060. </table>
  1061. </dd>
  1062. </dl>
  1063. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1064. <p>The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the <a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename()</a> call.</p>
  1065. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1066. </div>
  1067. </div>
  1068. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>
  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 FatFileSystem::rmdir </td>
  1077. <td>(</td>
  1078. <td class="paramtype">const char *&#160;</td>
  1079. <td class="paramname"><em>path</em></td><td>)</td>
  1080. <td></td>
  1081. </tr>
  1082. </table>
  1083. </td>
  1084. <td class="mlabels-right">
  1085. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1086. </tr>
  1087. </table>
  1088. </div><div class="memdoc">
  1089. <p>Remove a subdirectory from the volume's working directory.</p>
  1090. <dl class="params"><dt>Parameters</dt><dd>
  1091. <table class="params">
  1092. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  1093. </table>
  1094. </dd>
  1095. </dl>
  1096. <p>The subdirectory file will be removed only if it is empty.</p>
  1097. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1098. </div>
  1099. </div>
  1100. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>
  1101. <div class="memitem">
  1102. <div class="memproto">
  1103. <table class="mlabels">
  1104. <tr>
  1105. <td class="mlabels-left">
  1106. <table class="memname">
  1107. <tr>
  1108. <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>
  1109. <td>(</td>
  1110. <td class="paramname"></td><td>)</td>
  1111. <td> const</td>
  1112. </tr>
  1113. </table>
  1114. </td>
  1115. <td class="mlabels-right">
  1116. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1117. </tr>
  1118. </table>
  1119. </div><div class="memdoc">
  1120. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  1121. </div>
  1122. </div>
  1123. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>
  1124. <div class="memitem">
  1125. <div class="memproto">
  1126. <table class="mlabels">
  1127. <tr>
  1128. <td class="mlabels-left">
  1129. <table class="memname">
  1130. <tr>
  1131. <td class="memname">uint32_t FatVolume::rootDirStart </td>
  1132. <td>(</td>
  1133. <td class="paramname"></td><td>)</td>
  1134. <td> const</td>
  1135. </tr>
  1136. </table>
  1137. </td>
  1138. <td class="mlabels-right">
  1139. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1140. </tr>
  1141. </table>
  1142. </div><div class="memdoc">
  1143. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>
  1144. </div>
  1145. </div>
  1146. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>
  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 FatFileSystem::truncate </td>
  1155. <td>(</td>
  1156. <td class="paramtype">const char *&#160;</td>
  1157. <td class="paramname"><em>path</em>, </td>
  1158. </tr>
  1159. <tr>
  1160. <td class="paramkey"></td>
  1161. <td></td>
  1162. <td class="paramtype">uint32_t&#160;</td>
  1163. <td class="paramname"><em>length</em>&#160;</td>
  1164. </tr>
  1165. <tr>
  1166. <td></td>
  1167. <td>)</td>
  1168. <td></td><td></td>
  1169. </tr>
  1170. </table>
  1171. </td>
  1172. <td class="mlabels-right">
  1173. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1174. </tr>
  1175. </table>
  1176. </div><div class="memdoc">
  1177. <p>Truncate a file to a specified length. 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>
  1178. <dl class="params"><dt>Parameters</dt><dd>
  1179. <table class="params">
  1180. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the file. </td></tr>
  1181. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  1182. </table>
  1183. </dd>
  1184. </dl>
  1185. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1186. </div>
  1187. </div>
  1188. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>
  1189. <div class="memitem">
  1190. <div class="memproto">
  1191. <table class="mlabels">
  1192. <tr>
  1193. <td class="mlabels-left">
  1194. <table class="memname">
  1195. <tr>
  1196. <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>
  1197. <td>(</td>
  1198. <td class="paramname"></td><td>)</td>
  1199. <td></td>
  1200. </tr>
  1201. </table>
  1202. </td>
  1203. <td class="mlabels-right">
  1204. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1205. </tr>
  1206. </table>
  1207. </div><div class="memdoc">
  1208. <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> object. </dd></dl>
  1209. </div>
  1210. </div>
  1211. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>
  1212. <div class="memitem">
  1213. <div class="memproto">
  1214. <table class="mlabels">
  1215. <tr>
  1216. <td class="mlabels-left">
  1217. <table class="memname">
  1218. <tr>
  1219. <td class="memname">uint32_t FatVolume::volumeBlockCount </td>
  1220. <td>(</td>
  1221. <td class="paramname"></td><td>)</td>
  1222. <td> const</td>
  1223. </tr>
  1224. </table>
  1225. </td>
  1226. <td class="mlabels-right">
  1227. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1228. </tr>
  1229. </table>
  1230. </div><div class="memdoc">
  1231. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>
  1232. </div>
  1233. </div>
  1234. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>
  1235. <div class="memitem">
  1236. <div class="memproto">
  1237. <table class="mlabels">
  1238. <tr>
  1239. <td class="mlabels-left">
  1240. <table class="memname">
  1241. <tr>
  1242. <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>
  1243. <td>(</td>
  1244. <td class="paramname"></td><td>)</td>
  1245. <td></td>
  1246. </tr>
  1247. </table>
  1248. </td>
  1249. <td class="mlabels-right">
  1250. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1251. </tr>
  1252. </table>
  1253. </div><div class="memdoc">
  1254. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>
  1255. </div>
  1256. </div>
  1257. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>
  1258. <div class="memitem">
  1259. <div class="memproto">
  1260. <table class="mlabels">
  1261. <tr>
  1262. <td class="mlabels-left">
  1263. <table class="memname">
  1264. <tr>
  1265. <td class="memname">bool FatFileSystem::wipe </td>
  1266. <td>(</td>
  1267. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1268. <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>
  1269. <td></td>
  1270. </tr>
  1271. </table>
  1272. </td>
  1273. <td class="mlabels-right">
  1274. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1275. </tr>
  1276. </table>
  1277. </div><div class="memdoc">
  1278. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>
  1279. <table class="params">
  1280. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>
  1281. </table>
  1282. </dd>
  1283. </dl>
  1284. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  1285. </div>
  1286. </div>
  1287. <hr/>The documentation for this class was generated from the following file:<ul>
  1288. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_file_system_8h.html">FatFileSystem.h</a></li>
  1289. </ul>
  1290. </div><!-- contents -->
  1291. <!-- start footer part -->
  1292. <hr class="footer"/><address class="footer"><small>
  1293. Generated on Fri Aug 19 2016 08:28:00 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1294. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1295. </a> 1.8.10
  1296. </small></address>
  1297. </body>
  1298. </html>