Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.

1710 lines
73KB

  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: FatVolume 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. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  65. <a href="class_fat_volume-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">FatVolume Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Integration class for the FatLib library.
  71. <a href="class_fat_volume.html#details">More...</a></p>
  72. <p><code>#include &lt;FatVolume.h&gt;</code></p>
  73. <div class="dynheader">
  74. Inheritance diagram for FatVolume:</div>
  75. <div class="dyncontent">
  76. <div class="center"><img src="class_fat_volume__inherit__graph.png" border="0" usemap="#_fat_volume_inherit__map" alt="Inheritance graph"/></div>
  77. <map name="_fat_volume_inherit__map" id="_fat_volume_inherit__map">
  78. <area shape="rect" id="node3" href="class_sd_base.html" title="SdBase\&lt; FatVolume \&gt;" alt="" coords="5,155,160,181"/>
  79. <area shape="rect" id="node2" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices. " alt="" coords="38,5,127,32"/>
  80. <area shape="rect" id="node4" href="class_sd_fat32.html" title="SD file system class for FAT volumes. " alt="" coords="47,229,118,256"/>
  81. </map>
  82. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  83. <div class="dynheader">
  84. Collaboration diagram for FatVolume:</div>
  85. <div class="dyncontent">
  86. <div class="center"><img src="class_fat_volume__coll__graph.png" border="0" usemap="#_fat_volume_coll__map" alt="Collaboration graph"/></div>
  87. <map name="_fat_volume_coll__map" id="_fat_volume_coll__map">
  88. <area shape="rect" id="node2" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices. " alt="" coords="5,5,95,32"/>
  89. </map>
  90. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  93. Public Member Functions</h2></td></tr>
  94. <tr class="memitem:af3a219ea89bbbf310a61115c9a3d221a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af3a219ea89bbbf310a61115c9a3d221a">begin</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, bool setCwv=true, uint8_t part=1)</td></tr>
  95. <tr class="separator:af3a219ea89bbbf310a61115c9a3d221a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a1c3ab374b425c27bb6b6ddd55752c056"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1c3ab374b425c27bb6b6ddd55752c056">bytesPerCluster</a> ()</td></tr>
  97. <tr class="separator:a1c3ab374b425c27bb6b6ddd55752c056"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:aaf43a09e71689c257f4b189ee307db4f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#aaf43a09e71689c257f4b189ee307db4f">bytesPerClusterShift</a> ()</td></tr>
  99. <tr class="separator:aaf43a09e71689c257f4b189ee307db4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a1eba03c763bab44263735488435731f8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1eba03c763bab44263735488435731f8">bytesPerSector</a> ()</td></tr>
  101. <tr class="separator:a1eba03c763bab44263735488435731f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a4e513ab3fcfb95583092793116aa4df5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a4e513ab3fcfb95583092793116aa4df5">bytesPerSectorShift</a> ()</td></tr>
  103. <tr class="separator:a4e513ab3fcfb95583092793116aa4df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:abf74c1e3c714b396e6271aee304c2448"><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_partition.html#abf74c1e3c714b396e6271aee304c2448">cacheClear</a> ()</td></tr>
  105. <tr class="separator:abf74c1e3c714b396e6271aee304c2448"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a659d921b3efd52d310a33cba69eff18b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a659d921b3efd52d310a33cba69eff18b">chdir</a> ()</td></tr>
  107. <tr class="separator:a659d921b3efd52d310a33cba69eff18b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ac0f6cf6ece2285af777c1fdf5cf8c219"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac0f6cf6ece2285af777c1fdf5cf8c219">chdir</a> (const char *path)</td></tr>
  109. <tr class="separator:ac0f6cf6ece2285af777c1fdf5cf8c219"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ac591520e33ff8ba51e80782a87423872"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac591520e33ff8ba51e80782a87423872">chdir</a> (const String &amp;path)</td></tr>
  111. <tr class="separator:ac591520e33ff8ba51e80782a87423872"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a36fbc19755b066068cac7c4ca578b27b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a36fbc19755b066068cac7c4ca578b27b">chvol</a> ()</td></tr>
  113. <tr class="separator:a36fbc19755b066068cac7c4ca578b27b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:aba35645c23735c4833c07bc2b3adcd1f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#aba35645c23735c4833c07bc2b3adcd1f">clusterCount</a> () const</td></tr>
  115. <tr class="separator:aba35645c23735c4833c07bc2b3adcd1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a7e89ec91780f7dfa060b261c605bf2e5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a7e89ec91780f7dfa060b261c605bf2e5">dataStartSector</a> () const</td></tr>
  117. <tr class="separator:a7e89ec91780f7dfa060b261c605bf2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a0af1e91a311180119b4a2c85d7e6e87e">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  119. <tr class="separator:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a21541734ad76f64ea24b9f45e2bd6117"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a21541734ad76f64ea24b9f45e2bd6117">exists</a> (const char *path)</td></tr>
  121. <tr class="separator:a21541734ad76f64ea24b9f45e2bd6117"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:afb7709e5b9e04265467305b43adf7cef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#afb7709e5b9e04265467305b43adf7cef">exists</a> (const String &amp;path)</td></tr>
  123. <tr class="separator:afb7709e5b9e04265467305b43adf7cef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a56b37c3230818b9ae8e0a25c01a370a3">fatCount</a> ()</td></tr>
  125. <tr class="separator:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a6a1ce7d707cf15bea08b63216413e055"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6a1ce7d707cf15bea08b63216413e055">fatStartSector</a> () const</td></tr>
  127. <tr class="separator:a6a1ce7d707cf15bea08b63216413e055"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ad45c276232d7093b82f1075e8c488bac"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ad45c276232d7093b82f1075e8c488bac">fatType</a> () const</td></tr>
  129. <tr class="separator:ad45c276232d7093b82f1075e8c488bac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ac9689f1e11f59acc5f1b21ed9bb71174">freeClusterCount</a> ()</td></tr>
  131. <tr class="separator:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ab827224f30eec57255d21cae589911ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ab827224f30eec57255d21cae589911ef">init</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, uint8_t part=1)</td></tr>
  133. <tr class="separator:ab827224f30eec57255d21cae589911ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ae40964f357cfff4208812344a0e6f26f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae40964f357cfff4208812344a0e6f26f">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>
  135. <tr class="separator:ae40964f357cfff4208812344a0e6f26f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:ac5fc83cac7fd3af0b140a7986b9472f8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac5fc83cac7fd3af0b140a7986b9472f8">ls</a> (<a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  137. <tr class="separator:ac5fc83cac7fd3af0b140a7986b9472f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:ad455ad05551329865c659cc4676f2d18"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ad455ad05551329865c659cc4676f2d18">ls</a> (uint8_t flags=0)</td></tr>
  139. <tr class="separator:ad455ad05551329865c659cc4676f2d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a455ad7b2a5b6b31551dca08087a3c404"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a455ad7b2a5b6b31551dca08087a3c404">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  141. <tr class="separator:a455ad7b2a5b6b31551dca08087a3c404"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:ad80bccf8f24ff001a7b9277effc2cc52"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ad80bccf8f24ff001a7b9277effc2cc52">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  143. <tr class="separator:ad80bccf8f24ff001a7b9277effc2cc52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ab423ec4f7e5b58a6d454f328f61fd864"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab423ec4f7e5b58a6d454f328f61fd864">mkdir</a> (const String &amp;path, bool pFlag=true)</td></tr>
  145. <tr class="separator:ab423ec4f7e5b58a6d454f328f61fd864"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a22923b86de9c797ce5e19f206dd4ce1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file32.html">File32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a22923b86de9c797ce5e19f206dd4ce1f">open</a> (const char *path, oflag_t oflag=0X00)</td></tr>
  147. <tr class="separator:a22923b86de9c797ce5e19f206dd4ce1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:af7178b7f13eeae7748640b6268a34812"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file32.html">File32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af7178b7f13eeae7748640b6268a34812">open</a> (const String &amp;path, oflag_t oflag=0X00)</td></tr>
  149. <tr class="separator:af7178b7f13eeae7748640b6268a34812"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:abb11d05ef407775bcdb9b14a6c608433"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#abb11d05ef407775bcdb9b14a6c608433">remove</a> (const char *path)</td></tr>
  151. <tr class="separator:abb11d05ef407775bcdb9b14a6c608433"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a994411f55df474be6be87f06100c2c39"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a994411f55df474be6be87f06100c2c39">remove</a> (const String &amp;path)</td></tr>
  153. <tr class="separator:a994411f55df474be6be87f06100c2c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a5e4ea6c91569dc435c7aacd7ba704911"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  155. <tr class="separator:a5e4ea6c91569dc435c7aacd7ba704911"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:aa7015c0f694261780081c79c05d0882d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#aa7015c0f694261780081c79c05d0882d">rename</a> (const String &amp;oldPath, const String &amp;newPath)</td></tr>
  157. <tr class="separator:aa7015c0f694261780081c79c05d0882d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:af1181990bcece7dbb7d19293dd4fe11a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#af1181990bcece7dbb7d19293dd4fe11a">rmdir</a> (const char *path)</td></tr>
  159. <tr class="separator:af1181990bcece7dbb7d19293dd4fe11a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a105f437fb649b57ed3823f8ff1a2f37e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a105f437fb649b57ed3823f8ff1a2f37e">rmdir</a> (const String &amp;path)</td></tr>
  161. <tr class="separator:a105f437fb649b57ed3823f8ff1a2f37e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a6ba99b9711269b5ab6ca091b88e81288"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6ba99b9711269b5ab6ca091b88e81288">rootDirEntryCount</a> () const</td></tr>
  163. <tr class="separator:a6ba99b9711269b5ab6ca091b88e81288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a5d005e0f6fd4b84da8a5ebdea03aaf85"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a5d005e0f6fd4b84da8a5ebdea03aaf85">rootDirStart</a> () const</td></tr>
  165. <tr class="separator:a5d005e0f6fd4b84da8a5ebdea03aaf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a6b970fa2e06de1a826b09e251dc3119b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6b970fa2e06de1a826b09e251dc3119b">sectorMask</a> ()</td></tr>
  167. <tr class="separator:a6b970fa2e06de1a826b09e251dc3119b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a836546c368e6ffe117e6ab8775d23eba"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a836546c368e6ffe117e6ab8775d23eba">sectorsPerCluster</a> () const</td></tr>
  169. <tr class="separator:a836546c368e6ffe117e6ab8775d23eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a593a27482ff8d993542d6f82bd92e26c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a593a27482ff8d993542d6f82bd92e26c">sectorsPerClusterShift</a> () const</td></tr>
  171. <tr class="separator:a593a27482ff8d993542d6f82bd92e26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1f5c7599333dbe152a3cdd60623ce6d1">sectorsPerFat</a> () const</td></tr>
  173. <tr class="separator:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a86a08bf789e33567418465b9b12751e2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a86a08bf789e33567418465b9b12751e2">truncate</a> (const char *path, uint32_t length)</td></tr>
  175. <tr class="separator:a86a08bf789e33567418465b9b12751e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a97ef39ec02c38c0772f0029d42edcb46"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a97ef39ec02c38c0772f0029d42edcb46">truncate</a> (const String &amp;path, uint32_t length)</td></tr>
  177. <tr class="separator:a97ef39ec02c38c0772f0029d42edcb46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a916ba7d67711bb62daf12ecd47ca4b8e">volumeSectorCount</a> () const</td></tr>
  179. <tr class="separator:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. </table><table class="memberdecls">
  181. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  182. Static Public Member Functions</h2></td></tr>
  183. <tr class="memitem:a06acd4a434456b6a4644ff79a0bf0a24"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a06acd4a434456b6a4644ff79a0bf0a24">cwv</a> ()</td></tr>
  184. <tr class="separator:a06acd4a434456b6a4644ff79a0bf0a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. </table>
  186. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  187. <div class="textblock"><p>Integration class for the FatLib library. </p>
  188. </div><h2 class="groupheader">Member Function Documentation</h2>
  189. <a id="af3a219ea89bbbf310a61115c9a3d221a"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#af3a219ea89bbbf310a61115c9a3d221a">&#9670;&nbsp;</a></span>begin()</h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">bool FatVolume::begin </td>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  201. <td class="paramname"><em>dev</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">bool&#160;</td>
  207. <td class="paramname"><em>setCwv</em> = <code>true</code>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype">uint8_t&#160;</td>
  213. <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>
  214. </tr>
  215. <tr>
  216. <td></td>
  217. <td>)</td>
  218. <td></td><td></td>
  219. </tr>
  220. </table>
  221. </td>
  222. <td class="mlabels-right">
  223. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Initialize an <a class="el" href="class_fat_volume.html" title="Integration class for the FatLib library. ">FatVolume</a> object. </p><dl class="params"><dt>Parameters</dt><dd>
  228. <table class="params">
  229. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Device block driver. </td></tr>
  230. <tr><td class="paramdir">[in]</td><td class="paramname">setCwv</td><td>Set current working volume if true. </td></tr>
  231. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>
  232. </table>
  233. </dd>
  234. </dl>
  235. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  236. </div>
  237. </div>
  238. <a id="a1c3ab374b425c27bb6b6ddd55752c056"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#a1c3ab374b425c27bb6b6ddd55752c056">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="mlabels">
  243. <tr>
  244. <td class="mlabels-left">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">uint16_t FatPartition::bytesPerCluster </td>
  248. <td>(</td>
  249. <td class="paramname"></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </td>
  254. <td class="mlabels-right">
  255. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. <dl class="section return"><dt>Returns</dt><dd>Number of bytes in a cluster. </dd></dl>
  260. </div>
  261. </div>
  262. <a id="aaf43a09e71689c257f4b189ee307db4f"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#aaf43a09e71689c257f4b189ee307db4f">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="mlabels">
  267. <tr>
  268. <td class="mlabels-left">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">uint8_t FatPartition::bytesPerClusterShift </td>
  272. <td>(</td>
  273. <td class="paramname"></td><td>)</td>
  274. <td></td>
  275. </tr>
  276. </table>
  277. </td>
  278. <td class="mlabels-right">
  279. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>
  284. </div>
  285. </div>
  286. <a id="a1eba03c763bab44263735488435731f8"></a>
  287. <h2 class="memtitle"><span class="permalink"><a href="#a1eba03c763bab44263735488435731f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="mlabels">
  291. <tr>
  292. <td class="mlabels-left">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">uint16_t FatPartition::bytesPerSector </td>
  296. <td>(</td>
  297. <td class="paramname"></td><td>)</td>
  298. <td></td>
  299. </tr>
  300. </table>
  301. </td>
  302. <td class="mlabels-right">
  303. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <dl class="section return"><dt>Returns</dt><dd>Number of bytes per sector. </dd></dl>
  308. </div>
  309. </div>
  310. <a id="a4e513ab3fcfb95583092793116aa4df5"></a>
  311. <h2 class="memtitle"><span class="permalink"><a href="#a4e513ab3fcfb95583092793116aa4df5">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="mlabels">
  315. <tr>
  316. <td class="mlabels-left">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">uint8_t FatPartition::bytesPerSectorShift </td>
  320. <td>(</td>
  321. <td class="paramname"></td><td>)</td>
  322. <td></td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>
  332. </div>
  333. </div>
  334. <a id="abf74c1e3c714b396e6271aee304c2448"></a>
  335. <h2 class="memtitle"><span class="permalink"><a href="#abf74c1e3c714b396e6271aee304c2448">&#9670;&nbsp;</a></span>cacheClear()</h2>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <table class="mlabels">
  339. <tr>
  340. <td class="mlabels-left">
  341. <table class="memname">
  342. <tr>
  343. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatPartition::cacheClear </td>
  344. <td>(</td>
  345. <td class="paramname"></td><td>)</td>
  346. <td></td>
  347. </tr>
  348. </table>
  349. </td>
  350. <td class="mlabels-right">
  351. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <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>
  356. </div>
  357. </div>
  358. <a id="a659d921b3efd52d310a33cba69eff18b"></a>
  359. <h2 class="memtitle"><span class="permalink"><a href="#a659d921b3efd52d310a33cba69eff18b">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/3]</span></h2>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="mlabels">
  363. <tr>
  364. <td class="mlabels-left">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">bool FatVolume::chdir </td>
  368. <td>(</td>
  369. <td class="paramname"></td><td>)</td>
  370. <td></td>
  371. </tr>
  372. </table>
  373. </td>
  374. <td class="mlabels-right">
  375. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  376. </tr>
  377. </table>
  378. </div><div class="memdoc">
  379. <p>Set volume working directory to root. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  380. </div>
  381. </div>
  382. <a id="ac0f6cf6ece2285af777c1fdf5cf8c219"></a>
  383. <h2 class="memtitle"><span class="permalink"><a href="#ac0f6cf6ece2285af777c1fdf5cf8c219">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/3]</span></h2>
  384. <div class="memitem">
  385. <div class="memproto">
  386. <table class="memname">
  387. <tr>
  388. <td class="memname">bool FatVolume::chdir </td>
  389. <td>(</td>
  390. <td class="paramtype">const char *&#160;</td>
  391. <td class="paramname"><em>path</em></td><td>)</td>
  392. <td></td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  397. <table class="params">
  398. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  399. </table>
  400. </dd>
  401. </dl>
  402. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  403. </div>
  404. </div>
  405. <a id="ac591520e33ff8ba51e80782a87423872"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#ac591520e33ff8ba51e80782a87423872">&#9670;&nbsp;</a></span>chdir() <span class="overload">[3/3]</span></h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="mlabels">
  410. <tr>
  411. <td class="mlabels-left">
  412. <table class="memname">
  413. <tr>
  414. <td class="memname">bool FatVolume::chdir </td>
  415. <td>(</td>
  416. <td class="paramtype">const String &amp;&#160;</td>
  417. <td class="paramname"><em>path</em></td><td>)</td>
  418. <td></td>
  419. </tr>
  420. </table>
  421. </td>
  422. <td class="mlabels-right">
  423. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  428. <table class="params">
  429. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  430. </table>
  431. </dd>
  432. </dl>
  433. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  434. </div>
  435. </div>
  436. <a id="a36fbc19755b066068cac7c4ca578b27b"></a>
  437. <h2 class="memtitle"><span class="permalink"><a href="#a36fbc19755b066068cac7c4ca578b27b">&#9670;&nbsp;</a></span>chvol()</h2>
  438. <div class="memitem">
  439. <div class="memproto">
  440. <table class="mlabels">
  441. <tr>
  442. <td class="mlabels-left">
  443. <table class="memname">
  444. <tr>
  445. <td class="memname">void FatVolume::chvol </td>
  446. <td>(</td>
  447. <td class="paramname"></td><td>)</td>
  448. <td></td>
  449. </tr>
  450. </table>
  451. </td>
  452. <td class="mlabels-right">
  453. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  454. </tr>
  455. </table>
  456. </div><div class="memdoc">
  457. <p>Change global current working volume to this volume. </p>
  458. </div>
  459. </div>
  460. <a id="aba35645c23735c4833c07bc2b3adcd1f"></a>
  461. <h2 class="memtitle"><span class="permalink"><a href="#aba35645c23735c4833c07bc2b3adcd1f">&#9670;&nbsp;</a></span>clusterCount()</h2>
  462. <div class="memitem">
  463. <div class="memproto">
  464. <table class="mlabels">
  465. <tr>
  466. <td class="mlabels-left">
  467. <table class="memname">
  468. <tr>
  469. <td class="memname">uint32_t FatPartition::clusterCount </td>
  470. <td>(</td>
  471. <td class="paramname"></td><td>)</td>
  472. <td> const</td>
  473. </tr>
  474. </table>
  475. </td>
  476. <td class="mlabels-right">
  477. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  478. </tr>
  479. </table>
  480. </div><div class="memdoc">
  481. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  482. </div>
  483. </div>
  484. <a id="a06acd4a434456b6a4644ff79a0bf0a24"></a>
  485. <h2 class="memtitle"><span class="permalink"><a href="#a06acd4a434456b6a4644ff79a0bf0a24">&#9670;&nbsp;</a></span>cwv()</h2>
  486. <div class="memitem">
  487. <div class="memproto">
  488. <table class="mlabels">
  489. <tr>
  490. <td class="mlabels-left">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname">static <a class="el" href="class_fat_volume.html">FatVolume</a>* FatVolume::cwv </td>
  494. <td>(</td>
  495. <td class="paramname"></td><td>)</td>
  496. <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">static</span></span> </td>
  502. </tr>
  503. </table>
  504. </div><div class="memdoc">
  505. <dl class="section return"><dt>Returns</dt><dd>current working volume. </dd></dl>
  506. </div>
  507. </div>
  508. <a id="a7e89ec91780f7dfa060b261c605bf2e5"></a>
  509. <h2 class="memtitle"><span class="permalink"><a href="#a7e89ec91780f7dfa060b261c605bf2e5">&#9670;&nbsp;</a></span>dataStartSector()</h2>
  510. <div class="memitem">
  511. <div class="memproto">
  512. <table class="mlabels">
  513. <tr>
  514. <td class="mlabels-left">
  515. <table class="memname">
  516. <tr>
  517. <td class="memname">uint32_t FatPartition::dataStartSector </td>
  518. <td>(</td>
  519. <td class="paramname"></td><td>)</td>
  520. <td> const</td>
  521. </tr>
  522. </table>
  523. </td>
  524. <td class="mlabels-right">
  525. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  526. </tr>
  527. </table>
  528. </div><div class="memdoc">
  529. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>
  530. </div>
  531. </div>
  532. <a id="a0af1e91a311180119b4a2c85d7e6e87e"></a>
  533. <h2 class="memtitle"><span class="permalink"><a href="#a0af1e91a311180119b4a2c85d7e6e87e">&#9670;&nbsp;</a></span>dbgFat()</h2>
  534. <div class="memitem">
  535. <div class="memproto">
  536. <table class="mlabels">
  537. <tr>
  538. <td class="mlabels-left">
  539. <table class="memname">
  540. <tr>
  541. <td class="memname">int8_t FatPartition::dbgFat </td>
  542. <td>(</td>
  543. <td class="paramtype">uint32_t&#160;</td>
  544. <td class="paramname"><em>n</em>, </td>
  545. </tr>
  546. <tr>
  547. <td class="paramkey"></td>
  548. <td></td>
  549. <td class="paramtype">uint32_t *&#160;</td>
  550. <td class="paramname"><em>v</em>&#160;</td>
  551. </tr>
  552. <tr>
  553. <td></td>
  554. <td>)</td>
  555. <td></td><td></td>
  556. </tr>
  557. </table>
  558. </td>
  559. <td class="mlabels-right">
  560. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  561. </tr>
  562. </table>
  563. </div><div class="memdoc">
  564. <p>Debug access to FAT table</p>
  565. <dl class="params"><dt>Parameters</dt><dd>
  566. <table class="params">
  567. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  568. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  569. </table>
  570. </dd>
  571. </dl>
  572. <dl class="section return"><dt>Returns</dt><dd>-1 error, 0 EOC, else 1. </dd></dl>
  573. </div>
  574. </div>
  575. <a id="a21541734ad76f64ea24b9f45e2bd6117"></a>
  576. <h2 class="memtitle"><span class="permalink"><a href="#a21541734ad76f64ea24b9f45e2bd6117">&#9670;&nbsp;</a></span>exists() <span class="overload">[1/2]</span></h2>
  577. <div class="memitem">
  578. <div class="memproto">
  579. <table class="mlabels">
  580. <tr>
  581. <td class="mlabels-left">
  582. <table class="memname">
  583. <tr>
  584. <td class="memname">bool FatVolume::exists </td>
  585. <td>(</td>
  586. <td class="paramtype">const char *&#160;</td>
  587. <td class="paramname"><em>path</em></td><td>)</td>
  588. <td></td>
  589. </tr>
  590. </table>
  591. </td>
  592. <td class="mlabels-right">
  593. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  594. </tr>
  595. </table>
  596. </div><div class="memdoc">
  597. <p>Test for the existence of a file.</p>
  598. <dl class="params"><dt>Parameters</dt><dd>
  599. <table class="params">
  600. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  601. </table>
  602. </dd>
  603. </dl>
  604. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  605. </div>
  606. </div>
  607. <a id="afb7709e5b9e04265467305b43adf7cef"></a>
  608. <h2 class="memtitle"><span class="permalink"><a href="#afb7709e5b9e04265467305b43adf7cef">&#9670;&nbsp;</a></span>exists() <span class="overload">[2/2]</span></h2>
  609. <div class="memitem">
  610. <div class="memproto">
  611. <table class="mlabels">
  612. <tr>
  613. <td class="mlabels-left">
  614. <table class="memname">
  615. <tr>
  616. <td class="memname">bool FatVolume::exists </td>
  617. <td>(</td>
  618. <td class="paramtype">const String &amp;&#160;</td>
  619. <td class="paramname"><em>path</em></td><td>)</td>
  620. <td></td>
  621. </tr>
  622. </table>
  623. </td>
  624. <td class="mlabels-right">
  625. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  626. </tr>
  627. </table>
  628. </div><div class="memdoc">
  629. <p>Test for the existence of a file.</p>
  630. <dl class="params"><dt>Parameters</dt><dd>
  631. <table class="params">
  632. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  633. </table>
  634. </dd>
  635. </dl>
  636. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  637. </div>
  638. </div>
  639. <a id="a56b37c3230818b9ae8e0a25c01a370a3"></a>
  640. <h2 class="memtitle"><span class="permalink"><a href="#a56b37c3230818b9ae8e0a25c01a370a3">&#9670;&nbsp;</a></span>fatCount()</h2>
  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">uint8_t FatPartition::fatCount </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. <dl class="section return"><dt>Returns</dt><dd>The number of File Allocation Tables. </dd></dl>
  661. </div>
  662. </div>
  663. <a id="a6a1ce7d707cf15bea08b63216413e055"></a>
  664. <h2 class="memtitle"><span class="permalink"><a href="#a6a1ce7d707cf15bea08b63216413e055">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  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">uint32_t FatPartition::fatStartSector </td>
  673. <td>(</td>
  674. <td class="paramname"></td><td>)</td>
  675. <td> const</td>
  676. </tr>
  677. </table>
  678. </td>
  679. <td class="mlabels-right">
  680. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  681. </tr>
  682. </table>
  683. </div><div class="memdoc">
  684. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>
  685. </div>
  686. </div>
  687. <a id="ad45c276232d7093b82f1075e8c488bac"></a>
  688. <h2 class="memtitle"><span class="permalink"><a href="#ad45c276232d7093b82f1075e8c488bac">&#9670;&nbsp;</a></span>fatType()</h2>
  689. <div class="memitem">
  690. <div class="memproto">
  691. <table class="mlabels">
  692. <tr>
  693. <td class="mlabels-left">
  694. <table class="memname">
  695. <tr>
  696. <td class="memname">uint8_t FatPartition::fatType </td>
  697. <td>(</td>
  698. <td class="paramname"></td><td>)</td>
  699. <td> const</td>
  700. </tr>
  701. </table>
  702. </td>
  703. <td class="mlabels-right">
  704. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  705. </tr>
  706. </table>
  707. </div><div class="memdoc">
  708. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  709. </div>
  710. </div>
  711. <a id="ac9689f1e11f59acc5f1b21ed9bb71174"></a>
  712. <h2 class="memtitle"><span class="permalink"><a href="#ac9689f1e11f59acc5f1b21ed9bb71174">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  713. <div class="memitem">
  714. <div class="memproto">
  715. <table class="mlabels">
  716. <tr>
  717. <td class="mlabels-left">
  718. <table class="memname">
  719. <tr>
  720. <td class="memname">int32_t FatPartition::freeClusterCount </td>
  721. <td>(</td>
  722. <td class="paramname"></td><td>)</td>
  723. <td></td>
  724. </tr>
  725. </table>
  726. </td>
  727. <td class="mlabels-right">
  728. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  729. </tr>
  730. </table>
  731. </div><div class="memdoc">
  732. <p>Volume free space in clusters.</p>
  733. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  734. </div>
  735. </div>
  736. <a id="ab827224f30eec57255d21cae589911ef"></a>
  737. <h2 class="memtitle"><span class="permalink"><a href="#ab827224f30eec57255d21cae589911ef">&#9670;&nbsp;</a></span>init()</h2>
  738. <div class="memitem">
  739. <div class="memproto">
  740. <table class="mlabels">
  741. <tr>
  742. <td class="mlabels-left">
  743. <table class="memname">
  744. <tr>
  745. <td class="memname">bool FatPartition::init </td>
  746. <td>(</td>
  747. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  748. <td class="paramname"><em>dev</em>, </td>
  749. </tr>
  750. <tr>
  751. <td class="paramkey"></td>
  752. <td></td>
  753. <td class="paramtype">uint8_t&#160;</td>
  754. <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>
  755. </tr>
  756. <tr>
  757. <td></td>
  758. <td>)</td>
  759. <td></td><td></td>
  760. </tr>
  761. </table>
  762. </td>
  763. <td class="mlabels-right">
  764. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  765. </tr>
  766. </table>
  767. </div><div class="memdoc">
  768. <p>Initialize a FAT partition.</p>
  769. <dl class="params"><dt>Parameters</dt><dd>
  770. <table class="params">
  771. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>BlockDevice for this partition. </td></tr>
  772. <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 sector zero.</td></tr>
  773. </table>
  774. </dd>
  775. </dl>
  776. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  777. </div>
  778. </div>
  779. <a id="ae40964f357cfff4208812344a0e6f26f"></a>
  780. <h2 class="memtitle"><span class="permalink"><a href="#ae40964f357cfff4208812344a0e6f26f">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/4]</span></h2>
  781. <div class="memitem">
  782. <div class="memproto">
  783. <table class="mlabels">
  784. <tr>
  785. <td class="mlabels-left">
  786. <table class="memname">
  787. <tr>
  788. <td class="memname">bool FatVolume::ls </td>
  789. <td>(</td>
  790. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  791. <td class="paramname"><em>pr</em>, </td>
  792. </tr>
  793. <tr>
  794. <td class="paramkey"></td>
  795. <td></td>
  796. <td class="paramtype">uint8_t&#160;</td>
  797. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  798. </tr>
  799. <tr>
  800. <td></td>
  801. <td>)</td>
  802. <td></td><td></td>
  803. </tr>
  804. </table>
  805. </td>
  806. <td class="mlabels-right">
  807. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  808. </tr>
  809. </table>
  810. </div><div class="memdoc">
  811. <p>List the directory contents of the volume root directory.</p>
  812. <dl class="params"><dt>Parameters</dt><dd>
  813. <table class="params">
  814. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  815. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  816. </table>
  817. </dd>
  818. </dl>
  819. <p>LS_DATE - Print file modification date</p>
  820. <p>LS_SIZE - Print file size.</p>
  821. <p>LS_R - Recursive list of subdirectories.</p>
  822. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  823. </div>
  824. </div>
  825. <a id="ac5fc83cac7fd3af0b140a7986b9472f8"></a>
  826. <h2 class="memtitle"><span class="permalink"><a href="#ac5fc83cac7fd3af0b140a7986b9472f8">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/4]</span></h2>
  827. <div class="memitem">
  828. <div class="memproto">
  829. <table class="mlabels">
  830. <tr>
  831. <td class="mlabels-left">
  832. <table class="memname">
  833. <tr>
  834. <td class="memname">bool FatVolume::ls </td>
  835. <td>(</td>
  836. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  837. <td class="paramname"><em>pr</em>, </td>
  838. </tr>
  839. <tr>
  840. <td class="paramkey"></td>
  841. <td></td>
  842. <td class="paramtype">const char *&#160;</td>
  843. <td class="paramname"><em>path</em>, </td>
  844. </tr>
  845. <tr>
  846. <td class="paramkey"></td>
  847. <td></td>
  848. <td class="paramtype">uint8_t&#160;</td>
  849. <td class="paramname"><em>flags</em>&#160;</td>
  850. </tr>
  851. <tr>
  852. <td></td>
  853. <td>)</td>
  854. <td></td><td></td>
  855. </tr>
  856. </table>
  857. </td>
  858. <td class="mlabels-right">
  859. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  860. </tr>
  861. </table>
  862. </div><div class="memdoc">
  863. <p>List the contents of a directory.</p>
  864. <dl class="params"><dt>Parameters</dt><dd>
  865. <table class="params">
  866. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  867. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  868. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  869. </table>
  870. </dd>
  871. </dl>
  872. <p>LS_DATE - Print file modification date</p>
  873. <p>LS_SIZE - Print file size.</p>
  874. <p>LS_R - Recursive list of subdirectories.</p>
  875. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  876. </div>
  877. </div>
  878. <a id="ad455ad05551329865c659cc4676f2d18"></a>
  879. <h2 class="memtitle"><span class="permalink"><a href="#ad455ad05551329865c659cc4676f2d18">&#9670;&nbsp;</a></span>ls() <span class="overload">[3/4]</span></h2>
  880. <div class="memitem">
  881. <div class="memproto">
  882. <table class="mlabels">
  883. <tr>
  884. <td class="mlabels-left">
  885. <table class="memname">
  886. <tr>
  887. <td class="memname">bool FatVolume::ls </td>
  888. <td>(</td>
  889. <td class="paramtype">uint8_t&#160;</td>
  890. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  891. <td></td>
  892. </tr>
  893. </table>
  894. </td>
  895. <td class="mlabels-right">
  896. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  897. </tr>
  898. </table>
  899. </div><div class="memdoc">
  900. <p>List the directory contents of the root directory to Serial.</p>
  901. <dl class="params"><dt>Parameters</dt><dd>
  902. <table class="params">
  903. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  904. </table>
  905. </dd>
  906. </dl>
  907. <p>LS_DATE - Print file modification date</p>
  908. <p>LS_SIZE - Print file size.</p>
  909. <p>LS_R - Recursive list of subdirectories.</p>
  910. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  911. </div>
  912. </div>
  913. <a id="a455ad7b2a5b6b31551dca08087a3c404"></a>
  914. <h2 class="memtitle"><span class="permalink"><a href="#a455ad7b2a5b6b31551dca08087a3c404">&#9670;&nbsp;</a></span>ls() <span class="overload">[4/4]</span></h2>
  915. <div class="memitem">
  916. <div class="memproto">
  917. <table class="mlabels">
  918. <tr>
  919. <td class="mlabels-left">
  920. <table class="memname">
  921. <tr>
  922. <td class="memname">bool FatVolume::ls </td>
  923. <td>(</td>
  924. <td class="paramtype">const char *&#160;</td>
  925. <td class="paramname"><em>path</em>, </td>
  926. </tr>
  927. <tr>
  928. <td class="paramkey"></td>
  929. <td></td>
  930. <td class="paramtype">uint8_t&#160;</td>
  931. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  932. </tr>
  933. <tr>
  934. <td></td>
  935. <td>)</td>
  936. <td></td><td></td>
  937. </tr>
  938. </table>
  939. </td>
  940. <td class="mlabels-right">
  941. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  942. </tr>
  943. </table>
  944. </div><div class="memdoc">
  945. <p>List the directory contents of a directory to Serial.</p>
  946. <dl class="params"><dt>Parameters</dt><dd>
  947. <table class="params">
  948. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  949. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  950. </table>
  951. </dd>
  952. </dl>
  953. <p>LS_DATE - Print file modification date</p>
  954. <p>LS_SIZE - Print file size.</p>
  955. <p>LS_R - Recursive list of subdirectories.</p>
  956. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  957. </div>
  958. </div>
  959. <a id="ad80bccf8f24ff001a7b9277effc2cc52"></a>
  960. <h2 class="memtitle"><span class="permalink"><a href="#ad80bccf8f24ff001a7b9277effc2cc52">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[1/2]</span></h2>
  961. <div class="memitem">
  962. <div class="memproto">
  963. <table class="mlabels">
  964. <tr>
  965. <td class="mlabels-left">
  966. <table class="memname">
  967. <tr>
  968. <td class="memname">bool FatVolume::mkdir </td>
  969. <td>(</td>
  970. <td class="paramtype">const char *&#160;</td>
  971. <td class="paramname"><em>path</em>, </td>
  972. </tr>
  973. <tr>
  974. <td class="paramkey"></td>
  975. <td></td>
  976. <td class="paramtype">bool&#160;</td>
  977. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  978. </tr>
  979. <tr>
  980. <td></td>
  981. <td>)</td>
  982. <td></td><td></td>
  983. </tr>
  984. </table>
  985. </td>
  986. <td class="mlabels-right">
  987. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  988. </tr>
  989. </table>
  990. </div><div class="memdoc">
  991. <p>Make a subdirectory in the volume root directory.</p>
  992. <dl class="params"><dt>Parameters</dt><dd>
  993. <table class="params">
  994. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  995. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  996. </table>
  997. </dd>
  998. </dl>
  999. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1000. </div>
  1001. </div>
  1002. <a id="ab423ec4f7e5b58a6d454f328f61fd864"></a>
  1003. <h2 class="memtitle"><span class="permalink"><a href="#ab423ec4f7e5b58a6d454f328f61fd864">&#9670;&nbsp;</a></span>mkdir() <span class="overload">[2/2]</span></h2>
  1004. <div class="memitem">
  1005. <div class="memproto">
  1006. <table class="mlabels">
  1007. <tr>
  1008. <td class="mlabels-left">
  1009. <table class="memname">
  1010. <tr>
  1011. <td class="memname">bool FatVolume::mkdir </td>
  1012. <td>(</td>
  1013. <td class="paramtype">const String &amp;&#160;</td>
  1014. <td class="paramname"><em>path</em>, </td>
  1015. </tr>
  1016. <tr>
  1017. <td class="paramkey"></td>
  1018. <td></td>
  1019. <td class="paramtype">bool&#160;</td>
  1020. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1021. </tr>
  1022. <tr>
  1023. <td></td>
  1024. <td>)</td>
  1025. <td></td><td></td>
  1026. </tr>
  1027. </table>
  1028. </td>
  1029. <td class="mlabels-right">
  1030. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1031. </tr>
  1032. </table>
  1033. </div><div class="memdoc">
  1034. <p>Make a subdirectory in the volume root directory.</p>
  1035. <dl class="params"><dt>Parameters</dt><dd>
  1036. <table class="params">
  1037. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  1038. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1039. </table>
  1040. </dd>
  1041. </dl>
  1042. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1043. </div>
  1044. </div>
  1045. <a id="a22923b86de9c797ce5e19f206dd4ce1f"></a>
  1046. <h2 class="memtitle"><span class="permalink"><a href="#a22923b86de9c797ce5e19f206dd4ce1f">&#9670;&nbsp;</a></span>open() <span class="overload">[1/2]</span></h2>
  1047. <div class="memitem">
  1048. <div class="memproto">
  1049. <table class="mlabels">
  1050. <tr>
  1051. <td class="mlabels-left">
  1052. <table class="memname">
  1053. <tr>
  1054. <td class="memname"><a class="el" href="class_file32.html">File32</a> FatVolume::open </td>
  1055. <td>(</td>
  1056. <td class="paramtype">const char *&#160;</td>
  1057. <td class="paramname"><em>path</em>, </td>
  1058. </tr>
  1059. <tr>
  1060. <td class="paramkey"></td>
  1061. <td></td>
  1062. <td class="paramtype">oflag_t&#160;</td>
  1063. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1064. </tr>
  1065. <tr>
  1066. <td></td>
  1067. <td>)</td>
  1068. <td></td><td></td>
  1069. </tr>
  1070. </table>
  1071. </td>
  1072. <td class="mlabels-right">
  1073. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1074. </tr>
  1075. </table>
  1076. </div><div class="memdoc">
  1077. <p>open a file</p>
  1078. <dl class="params"><dt>Parameters</dt><dd>
  1079. <table class="params">
  1080. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1081. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  1082. </table>
  1083. </dd>
  1084. </dl>
  1085. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream. ">File32</a> object. </dd></dl>
  1086. </div>
  1087. </div>
  1088. <a id="af7178b7f13eeae7748640b6268a34812"></a>
  1089. <h2 class="memtitle"><span class="permalink"><a href="#af7178b7f13eeae7748640b6268a34812">&#9670;&nbsp;</a></span>open() <span class="overload">[2/2]</span></h2>
  1090. <div class="memitem">
  1091. <div class="memproto">
  1092. <table class="mlabels">
  1093. <tr>
  1094. <td class="mlabels-left">
  1095. <table class="memname">
  1096. <tr>
  1097. <td class="memname"><a class="el" href="class_file32.html">File32</a> FatVolume::open </td>
  1098. <td>(</td>
  1099. <td class="paramtype">const String &amp;&#160;</td>
  1100. <td class="paramname"><em>path</em>, </td>
  1101. </tr>
  1102. <tr>
  1103. <td class="paramkey"></td>
  1104. <td></td>
  1105. <td class="paramtype">oflag_t&#160;</td>
  1106. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  1107. </tr>
  1108. <tr>
  1109. <td></td>
  1110. <td>)</td>
  1111. <td></td><td></td>
  1112. </tr>
  1113. </table>
  1114. </td>
  1115. <td class="mlabels-right">
  1116. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1117. </tr>
  1118. </table>
  1119. </div><div class="memdoc">
  1120. <p>open a file</p>
  1121. <dl class="params"><dt>Parameters</dt><dd>
  1122. <table class="params">
  1123. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1124. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  1125. </table>
  1126. </dd>
  1127. </dl>
  1128. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file32.html" title="FAT16/FAT32 file with Arduino Stream. ">File32</a> object. </dd></dl>
  1129. </div>
  1130. </div>
  1131. <a id="abb11d05ef407775bcdb9b14a6c608433"></a>
  1132. <h2 class="memtitle"><span class="permalink"><a href="#abb11d05ef407775bcdb9b14a6c608433">&#9670;&nbsp;</a></span>remove() <span class="overload">[1/2]</span></h2>
  1133. <div class="memitem">
  1134. <div class="memproto">
  1135. <table class="mlabels">
  1136. <tr>
  1137. <td class="mlabels-left">
  1138. <table class="memname">
  1139. <tr>
  1140. <td class="memname">bool FatVolume::remove </td>
  1141. <td>(</td>
  1142. <td class="paramtype">const char *&#160;</td>
  1143. <td class="paramname"><em>path</em></td><td>)</td>
  1144. <td></td>
  1145. </tr>
  1146. </table>
  1147. </td>
  1148. <td class="mlabels-right">
  1149. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1150. </tr>
  1151. </table>
  1152. </div><div class="memdoc">
  1153. <p>Remove a file from the volume root directory.</p>
  1154. <dl class="params"><dt>Parameters</dt><dd>
  1155. <table class="params">
  1156. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file.</td></tr>
  1157. </table>
  1158. </dd>
  1159. </dl>
  1160. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1161. </div>
  1162. </div>
  1163. <a id="a994411f55df474be6be87f06100c2c39"></a>
  1164. <h2 class="memtitle"><span class="permalink"><a href="#a994411f55df474be6be87f06100c2c39">&#9670;&nbsp;</a></span>remove() <span class="overload">[2/2]</span></h2>
  1165. <div class="memitem">
  1166. <div class="memproto">
  1167. <table class="mlabels">
  1168. <tr>
  1169. <td class="mlabels-left">
  1170. <table class="memname">
  1171. <tr>
  1172. <td class="memname">bool FatVolume::remove </td>
  1173. <td>(</td>
  1174. <td class="paramtype">const String &amp;&#160;</td>
  1175. <td class="paramname"><em>path</em></td><td>)</td>
  1176. <td></td>
  1177. </tr>
  1178. </table>
  1179. </td>
  1180. <td class="mlabels-right">
  1181. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1182. </tr>
  1183. </table>
  1184. </div><div class="memdoc">
  1185. <p>Remove a file from the volume root directory.</p>
  1186. <dl class="params"><dt>Parameters</dt><dd>
  1187. <table class="params">
  1188. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file.</td></tr>
  1189. </table>
  1190. </dd>
  1191. </dl>
  1192. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1193. </div>
  1194. </div>
  1195. <a id="a5e4ea6c91569dc435c7aacd7ba704911"></a>
  1196. <h2 class="memtitle"><span class="permalink"><a href="#a5e4ea6c91569dc435c7aacd7ba704911">&#9670;&nbsp;</a></span>rename() <span class="overload">[1/2]</span></h2>
  1197. <div class="memitem">
  1198. <div class="memproto">
  1199. <table class="mlabels">
  1200. <tr>
  1201. <td class="mlabels-left">
  1202. <table class="memname">
  1203. <tr>
  1204. <td class="memname">bool FatVolume::rename </td>
  1205. <td>(</td>
  1206. <td class="paramtype">const char *&#160;</td>
  1207. <td class="paramname"><em>oldPath</em>, </td>
  1208. </tr>
  1209. <tr>
  1210. <td class="paramkey"></td>
  1211. <td></td>
  1212. <td class="paramtype">const char *&#160;</td>
  1213. <td class="paramname"><em>newPath</em>&#160;</td>
  1214. </tr>
  1215. <tr>
  1216. <td></td>
  1217. <td>)</td>
  1218. <td></td><td></td>
  1219. </tr>
  1220. </table>
  1221. </td>
  1222. <td class="mlabels-right">
  1223. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1224. </tr>
  1225. </table>
  1226. </div><div class="memdoc">
  1227. <p>Rename a file or subdirectory.</p>
  1228. <dl class="params"><dt>Parameters</dt><dd>
  1229. <table class="params">
  1230. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1231. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1232. </table>
  1233. </dd>
  1234. </dl>
  1235. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1236. <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_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename()</a> call.</p>
  1237. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1238. </div>
  1239. </div>
  1240. <a id="aa7015c0f694261780081c79c05d0882d"></a>
  1241. <h2 class="memtitle"><span class="permalink"><a href="#aa7015c0f694261780081c79c05d0882d">&#9670;&nbsp;</a></span>rename() <span class="overload">[2/2]</span></h2>
  1242. <div class="memitem">
  1243. <div class="memproto">
  1244. <table class="mlabels">
  1245. <tr>
  1246. <td class="mlabels-left">
  1247. <table class="memname">
  1248. <tr>
  1249. <td class="memname">bool FatVolume::rename </td>
  1250. <td>(</td>
  1251. <td class="paramtype">const String &amp;&#160;</td>
  1252. <td class="paramname"><em>oldPath</em>, </td>
  1253. </tr>
  1254. <tr>
  1255. <td class="paramkey"></td>
  1256. <td></td>
  1257. <td class="paramtype">const String &amp;&#160;</td>
  1258. <td class="paramname"><em>newPath</em>&#160;</td>
  1259. </tr>
  1260. <tr>
  1261. <td></td>
  1262. <td>)</td>
  1263. <td></td><td></td>
  1264. </tr>
  1265. </table>
  1266. </td>
  1267. <td class="mlabels-right">
  1268. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1269. </tr>
  1270. </table>
  1271. </div><div class="memdoc">
  1272. <p>Rename a file or subdirectory.</p>
  1273. <dl class="params"><dt>Parameters</dt><dd>
  1274. <table class="params">
  1275. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  1276. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  1277. </table>
  1278. </dd>
  1279. </dl>
  1280. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  1281. <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_volume.html#a5e4ea6c91569dc435c7aacd7ba704911">rename()</a> call.</p>
  1282. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1283. </div>
  1284. </div>
  1285. <a id="af1181990bcece7dbb7d19293dd4fe11a"></a>
  1286. <h2 class="memtitle"><span class="permalink"><a href="#af1181990bcece7dbb7d19293dd4fe11a">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[1/2]</span></h2>
  1287. <div class="memitem">
  1288. <div class="memproto">
  1289. <table class="mlabels">
  1290. <tr>
  1291. <td class="mlabels-left">
  1292. <table class="memname">
  1293. <tr>
  1294. <td class="memname">bool FatVolume::rmdir </td>
  1295. <td>(</td>
  1296. <td class="paramtype">const char *&#160;</td>
  1297. <td class="paramname"><em>path</em></td><td>)</td>
  1298. <td></td>
  1299. </tr>
  1300. </table>
  1301. </td>
  1302. <td class="mlabels-right">
  1303. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1304. </tr>
  1305. </table>
  1306. </div><div class="memdoc">
  1307. <p>Remove a subdirectory from the volume's working directory.</p>
  1308. <dl class="params"><dt>Parameters</dt><dd>
  1309. <table class="params">
  1310. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  1311. </table>
  1312. </dd>
  1313. </dl>
  1314. <p>The subdirectory file will be removed only if it is empty.</p>
  1315. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1316. </div>
  1317. </div>
  1318. <a id="a105f437fb649b57ed3823f8ff1a2f37e"></a>
  1319. <h2 class="memtitle"><span class="permalink"><a href="#a105f437fb649b57ed3823f8ff1a2f37e">&#9670;&nbsp;</a></span>rmdir() <span class="overload">[2/2]</span></h2>
  1320. <div class="memitem">
  1321. <div class="memproto">
  1322. <table class="mlabels">
  1323. <tr>
  1324. <td class="mlabels-left">
  1325. <table class="memname">
  1326. <tr>
  1327. <td class="memname">bool FatVolume::rmdir </td>
  1328. <td>(</td>
  1329. <td class="paramtype">const String &amp;&#160;</td>
  1330. <td class="paramname"><em>path</em></td><td>)</td>
  1331. <td></td>
  1332. </tr>
  1333. </table>
  1334. </td>
  1335. <td class="mlabels-right">
  1336. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1337. </tr>
  1338. </table>
  1339. </div><div class="memdoc">
  1340. <p>Remove a subdirectory from the volume's working directory.</p>
  1341. <dl class="params"><dt>Parameters</dt><dd>
  1342. <table class="params">
  1343. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  1344. </table>
  1345. </dd>
  1346. </dl>
  1347. <p>The subdirectory file will be removed only if it is empty.</p>
  1348. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1349. </div>
  1350. </div>
  1351. <a id="a6ba99b9711269b5ab6ca091b88e81288"></a>
  1352. <h2 class="memtitle"><span class="permalink"><a href="#a6ba99b9711269b5ab6ca091b88e81288">&#9670;&nbsp;</a></span>rootDirEntryCount()</h2>
  1353. <div class="memitem">
  1354. <div class="memproto">
  1355. <table class="mlabels">
  1356. <tr>
  1357. <td class="mlabels-left">
  1358. <table class="memname">
  1359. <tr>
  1360. <td class="memname">uint16_t FatPartition::rootDirEntryCount </td>
  1361. <td>(</td>
  1362. <td class="paramname"></td><td>)</td>
  1363. <td> const</td>
  1364. </tr>
  1365. </table>
  1366. </td>
  1367. <td class="mlabels-right">
  1368. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1369. </tr>
  1370. </table>
  1371. </div><div class="memdoc">
  1372. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  1373. </div>
  1374. </div>
  1375. <a id="a5d005e0f6fd4b84da8a5ebdea03aaf85"></a>
  1376. <h2 class="memtitle"><span class="permalink"><a href="#a5d005e0f6fd4b84da8a5ebdea03aaf85">&#9670;&nbsp;</a></span>rootDirStart()</h2>
  1377. <div class="memitem">
  1378. <div class="memproto">
  1379. <table class="mlabels">
  1380. <tr>
  1381. <td class="mlabels-left">
  1382. <table class="memname">
  1383. <tr>
  1384. <td class="memname">uint32_t FatPartition::rootDirStart </td>
  1385. <td>(</td>
  1386. <td class="paramname"></td><td>)</td>
  1387. <td> const</td>
  1388. </tr>
  1389. </table>
  1390. </td>
  1391. <td class="mlabels-right">
  1392. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1393. </tr>
  1394. </table>
  1395. </div><div class="memdoc">
  1396. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>
  1397. </div>
  1398. </div>
  1399. <a id="a6b970fa2e06de1a826b09e251dc3119b"></a>
  1400. <h2 class="memtitle"><span class="permalink"><a href="#a6b970fa2e06de1a826b09e251dc3119b">&#9670;&nbsp;</a></span>sectorMask()</h2>
  1401. <div class="memitem">
  1402. <div class="memproto">
  1403. <table class="mlabels">
  1404. <tr>
  1405. <td class="mlabels-left">
  1406. <table class="memname">
  1407. <tr>
  1408. <td class="memname">uint16_t FatPartition::sectorMask </td>
  1409. <td>(</td>
  1410. <td class="paramname"></td><td>)</td>
  1411. <td></td>
  1412. </tr>
  1413. </table>
  1414. </td>
  1415. <td class="mlabels-right">
  1416. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1417. </tr>
  1418. </table>
  1419. </div><div class="memdoc">
  1420. <dl class="section return"><dt>Returns</dt><dd>Mask for sector offset. </dd></dl>
  1421. </div>
  1422. </div>
  1423. <a id="a836546c368e6ffe117e6ab8775d23eba"></a>
  1424. <h2 class="memtitle"><span class="permalink"><a href="#a836546c368e6ffe117e6ab8775d23eba">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  1425. <div class="memitem">
  1426. <div class="memproto">
  1427. <table class="mlabels">
  1428. <tr>
  1429. <td class="mlabels-left">
  1430. <table class="memname">
  1431. <tr>
  1432. <td class="memname">uint8_t FatPartition::sectorsPerCluster </td>
  1433. <td>(</td>
  1434. <td class="paramname"></td><td>)</td>
  1435. <td> const</td>
  1436. </tr>
  1437. </table>
  1438. </td>
  1439. <td class="mlabels-right">
  1440. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1441. </tr>
  1442. </table>
  1443. </div><div class="memdoc">
  1444. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>
  1445. </div>
  1446. </div>
  1447. <a id="a593a27482ff8d993542d6f82bd92e26c"></a>
  1448. <h2 class="memtitle"><span class="permalink"><a href="#a593a27482ff8d993542d6f82bd92e26c">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>
  1449. <div class="memitem">
  1450. <div class="memproto">
  1451. <table class="mlabels">
  1452. <tr>
  1453. <td class="mlabels-left">
  1454. <table class="memname">
  1455. <tr>
  1456. <td class="memname">uint8_t FatPartition::sectorsPerClusterShift </td>
  1457. <td>(</td>
  1458. <td class="paramname"></td><td>)</td>
  1459. <td> const</td>
  1460. </tr>
  1461. </table>
  1462. </td>
  1463. <td class="mlabels-right">
  1464. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1465. </tr>
  1466. </table>
  1467. </div><div class="memdoc">
  1468. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by sectorsPerCluster. </dd></dl>
  1469. </div>
  1470. </div>
  1471. <a id="a1f5c7599333dbe152a3cdd60623ce6d1"></a>
  1472. <h2 class="memtitle"><span class="permalink"><a href="#a1f5c7599333dbe152a3cdd60623ce6d1">&#9670;&nbsp;</a></span>sectorsPerFat()</h2>
  1473. <div class="memitem">
  1474. <div class="memproto">
  1475. <table class="mlabels">
  1476. <tr>
  1477. <td class="mlabels-left">
  1478. <table class="memname">
  1479. <tr>
  1480. <td class="memname">uint32_t FatPartition::sectorsPerFat </td>
  1481. <td>(</td>
  1482. <td class="paramname"></td><td>)</td>
  1483. <td> const</td>
  1484. </tr>
  1485. </table>
  1486. </td>
  1487. <td class="mlabels-right">
  1488. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1489. </tr>
  1490. </table>
  1491. </div><div class="memdoc">
  1492. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in one FAT. </dd></dl>
  1493. </div>
  1494. </div>
  1495. <a id="a86a08bf789e33567418465b9b12751e2"></a>
  1496. <h2 class="memtitle"><span class="permalink"><a href="#a86a08bf789e33567418465b9b12751e2">&#9670;&nbsp;</a></span>truncate() <span class="overload">[1/2]</span></h2>
  1497. <div class="memitem">
  1498. <div class="memproto">
  1499. <table class="mlabels">
  1500. <tr>
  1501. <td class="mlabels-left">
  1502. <table class="memname">
  1503. <tr>
  1504. <td class="memname">bool FatVolume::truncate </td>
  1505. <td>(</td>
  1506. <td class="paramtype">const char *&#160;</td>
  1507. <td class="paramname"><em>path</em>, </td>
  1508. </tr>
  1509. <tr>
  1510. <td class="paramkey"></td>
  1511. <td></td>
  1512. <td class="paramtype">uint32_t&#160;</td>
  1513. <td class="paramname"><em>length</em>&#160;</td>
  1514. </tr>
  1515. <tr>
  1516. <td></td>
  1517. <td>)</td>
  1518. <td></td><td></td>
  1519. </tr>
  1520. </table>
  1521. </td>
  1522. <td class="mlabels-right">
  1523. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1524. </tr>
  1525. </table>
  1526. </div><div class="memdoc">
  1527. <p>Truncate a file to a specified length. The current file position will be at the new EOF.</p>
  1528. <dl class="params"><dt>Parameters</dt><dd>
  1529. <table class="params">
  1530. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file. </td></tr>
  1531. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  1532. </table>
  1533. </dd>
  1534. </dl>
  1535. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1536. </div>
  1537. </div>
  1538. <a id="a97ef39ec02c38c0772f0029d42edcb46"></a>
  1539. <h2 class="memtitle"><span class="permalink"><a href="#a97ef39ec02c38c0772f0029d42edcb46">&#9670;&nbsp;</a></span>truncate() <span class="overload">[2/2]</span></h2>
  1540. <div class="memitem">
  1541. <div class="memproto">
  1542. <table class="mlabels">
  1543. <tr>
  1544. <td class="mlabels-left">
  1545. <table class="memname">
  1546. <tr>
  1547. <td class="memname">bool FatVolume::truncate </td>
  1548. <td>(</td>
  1549. <td class="paramtype">const String &amp;&#160;</td>
  1550. <td class="paramname"><em>path</em>, </td>
  1551. </tr>
  1552. <tr>
  1553. <td class="paramkey"></td>
  1554. <td></td>
  1555. <td class="paramtype">uint32_t&#160;</td>
  1556. <td class="paramname"><em>length</em>&#160;</td>
  1557. </tr>
  1558. <tr>
  1559. <td></td>
  1560. <td>)</td>
  1561. <td></td><td></td>
  1562. </tr>
  1563. </table>
  1564. </td>
  1565. <td class="mlabels-right">
  1566. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1567. </tr>
  1568. </table>
  1569. </div><div class="memdoc">
  1570. <p>Truncate a file to a specified length. The current file position will be at the new EOF.</p>
  1571. <dl class="params"><dt>Parameters</dt><dd>
  1572. <table class="params">
  1573. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file. </td></tr>
  1574. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  1575. </table>
  1576. </dd>
  1577. </dl>
  1578. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1579. </div>
  1580. </div>
  1581. <a id="a916ba7d67711bb62daf12ecd47ca4b8e"></a>
  1582. <h2 class="memtitle"><span class="permalink"><a href="#a916ba7d67711bb62daf12ecd47ca4b8e">&#9670;&nbsp;</a></span>volumeSectorCount()</h2>
  1583. <div class="memitem">
  1584. <div class="memproto">
  1585. <table class="mlabels">
  1586. <tr>
  1587. <td class="mlabels-left">
  1588. <table class="memname">
  1589. <tr>
  1590. <td class="memname">uint32_t FatPartition::volumeSectorCount </td>
  1591. <td>(</td>
  1592. <td class="paramname"></td><td>)</td>
  1593. <td> const</td>
  1594. </tr>
  1595. </table>
  1596. </td>
  1597. <td class="mlabels-right">
  1598. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1599. </tr>
  1600. </table>
  1601. </div><div class="memdoc">
  1602. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in the volume </dd></dl>
  1603. </div>
  1604. </div>
  1605. <hr/>The documentation for this class was generated from the following files:<ul>
  1606. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_volume_8h.html">FatVolume.h</a></li>
  1607. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatVolume.cpp</li>
  1608. </ul>
  1609. </div><!-- contents -->
  1610. <!-- start footer part -->
  1611. <hr class="footer"/><address class="footer"><small>
  1612. Generated on Mon Nov 18 2019 08:14:17 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1613. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1614. </a> 1.8.14
  1615. </small></address>
  1616. </body>
  1617. </html>