Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

1287 lines
55KB

  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: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>
  111. <tr class="separator:a36fbc19755b066068cac7c4ca578b27b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:aba35645c23735c4833c07bc2b3adcd1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:a7e89ec91780f7dfa060b261c605bf2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:a21541734ad76f64ea24b9f45e2bd6117"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:a6a1ce7d707cf15bea08b63216413e055"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:ad45c276232d7093b82f1075e8c488bac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:ab827224f30eec57255d21cae589911ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint8_t flags=0)</td></tr>
  131. <tr class="separator:ae40964f357cfff4208812344a0e6f26f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  133. <tr class="separator:ac5fc83cac7fd3af0b140a7986b9472f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:ad80bccf8f24ff001a7b9277effc2cc52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:a22923b86de9c797ce5e19f206dd4ce1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:abb11d05ef407775bcdb9b14a6c608433"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:a5e4ea6c91569dc435c7aacd7ba704911"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:af1181990bcece7dbb7d19293dd4fe11a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:a6ba99b9711269b5ab6ca091b88e81288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:a5d005e0f6fd4b84da8a5ebdea03aaf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:a6b970fa2e06de1a826b09e251dc3119b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:a836546c368e6ffe117e6ab8775d23eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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>
  153. <tr class="separator:a593a27482ff8d993542d6f82bd92e26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <tr class="separator:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a86a08bf789e33567418465b9b12751e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="separator:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. </table><table class="memberdecls">
  161. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  162. Static Public Member Functions</h2></td></tr>
  163. <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>
  164. <tr class="separator:a06acd4a434456b6a4644ff79a0bf0a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. </table>
  166. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  167. <div class="textblock"><p>Integration class for the FatLib library. </p>
  168. </div><h2 class="groupheader">Member Function Documentation</h2>
  169. <a id="af3a219ea89bbbf310a61115c9a3d221a"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#af3a219ea89bbbf310a61115c9a3d221a">&#9670;&nbsp;</a></span>begin()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">bool FatVolume::begin </td>
  179. <td>(</td>
  180. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  181. <td class="paramname"><em>dev</em>, </td>
  182. </tr>
  183. <tr>
  184. <td class="paramkey"></td>
  185. <td></td>
  186. <td class="paramtype">bool&#160;</td>
  187. <td class="paramname"><em>setCwv</em> = <code>true</code>, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype">uint8_t&#160;</td>
  193. <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>
  194. </tr>
  195. <tr>
  196. <td></td>
  197. <td>)</td>
  198. <td></td><td></td>
  199. </tr>
  200. </table>
  201. </td>
  202. <td class="mlabels-right">
  203. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <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>
  208. <table class="params">
  209. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Device block driver. </td></tr>
  210. <tr><td class="paramdir">[in]</td><td class="paramname">setCwv</td><td>Set current working volume if true. </td></tr>
  211. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>
  212. </table>
  213. </dd>
  214. </dl>
  215. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  216. </div>
  217. </div>
  218. <a id="a1c3ab374b425c27bb6b6ddd55752c056"></a>
  219. <h2 class="memtitle"><span class="permalink"><a href="#a1c3ab374b425c27bb6b6ddd55752c056">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="mlabels">
  223. <tr>
  224. <td class="mlabels-left">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">uint16_t FatPartition::bytesPerCluster </td>
  228. <td>(</td>
  229. <td class="paramname"></td><td>)</td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </td>
  234. <td class="mlabels-right">
  235. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <dl class="section return"><dt>Returns</dt><dd>Number of bytes in a cluster. </dd></dl>
  240. </div>
  241. </div>
  242. <a id="aaf43a09e71689c257f4b189ee307db4f"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#aaf43a09e71689c257f4b189ee307db4f">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">uint8_t FatPartition::bytesPerClusterShift </td>
  252. <td>(</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td></td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>
  264. </div>
  265. </div>
  266. <a id="a1eba03c763bab44263735488435731f8"></a>
  267. <h2 class="memtitle"><span class="permalink"><a href="#a1eba03c763bab44263735488435731f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="mlabels">
  271. <tr>
  272. <td class="mlabels-left">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname">uint16_t FatPartition::bytesPerSector </td>
  276. <td>(</td>
  277. <td class="paramname"></td><td>)</td>
  278. <td></td>
  279. </tr>
  280. </table>
  281. </td>
  282. <td class="mlabels-right">
  283. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <dl class="section return"><dt>Returns</dt><dd>Number of bytes per sector. </dd></dl>
  288. </div>
  289. </div>
  290. <a id="a4e513ab3fcfb95583092793116aa4df5"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#a4e513ab3fcfb95583092793116aa4df5">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">uint8_t FatPartition::bytesPerSectorShift </td>
  300. <td>(</td>
  301. <td class="paramname"></td><td>)</td>
  302. <td></td>
  303. </tr>
  304. </table>
  305. </td>
  306. <td class="mlabels-right">
  307. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>
  312. </div>
  313. </div>
  314. <a id="abf74c1e3c714b396e6271aee304c2448"></a>
  315. <h2 class="memtitle"><span class="permalink"><a href="#abf74c1e3c714b396e6271aee304c2448">&#9670;&nbsp;</a></span>cacheClear()</h2>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="mlabels">
  319. <tr>
  320. <td class="mlabels-left">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatPartition::cacheClear </td>
  324. <td>(</td>
  325. <td class="paramname"></td><td>)</td>
  326. <td></td>
  327. </tr>
  328. </table>
  329. </td>
  330. <td class="mlabels-right">
  331. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <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>
  336. </div>
  337. </div>
  338. <a id="a659d921b3efd52d310a33cba69eff18b"></a>
  339. <h2 class="memtitle"><span class="permalink"><a href="#a659d921b3efd52d310a33cba69eff18b">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/2]</span></h2>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="mlabels">
  343. <tr>
  344. <td class="mlabels-left">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname">bool FatVolume::chdir </td>
  348. <td>(</td>
  349. <td class="paramname"></td><td>)</td>
  350. <td></td>
  351. </tr>
  352. </table>
  353. </td>
  354. <td class="mlabels-right">
  355. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <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>
  360. </div>
  361. </div>
  362. <a id="ac0f6cf6ece2285af777c1fdf5cf8c219"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#ac0f6cf6ece2285af777c1fdf5cf8c219">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/2]</span></h2>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname">bool FatVolume::chdir </td>
  369. <td>(</td>
  370. <td class="paramtype">const char *&#160;</td>
  371. <td class="paramname"><em>path</em></td><td>)</td>
  372. <td></td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  377. <table class="params">
  378. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  379. </table>
  380. </dd>
  381. </dl>
  382. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  383. </div>
  384. </div>
  385. <a id="a36fbc19755b066068cac7c4ca578b27b"></a>
  386. <h2 class="memtitle"><span class="permalink"><a href="#a36fbc19755b066068cac7c4ca578b27b">&#9670;&nbsp;</a></span>chvol()</h2>
  387. <div class="memitem">
  388. <div class="memproto">
  389. <table class="mlabels">
  390. <tr>
  391. <td class="mlabels-left">
  392. <table class="memname">
  393. <tr>
  394. <td class="memname">void FatVolume::chvol </td>
  395. <td>(</td>
  396. <td class="paramname"></td><td>)</td>
  397. <td></td>
  398. </tr>
  399. </table>
  400. </td>
  401. <td class="mlabels-right">
  402. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. <p>Change global current working volume to this volume. </p>
  407. </div>
  408. </div>
  409. <a id="aba35645c23735c4833c07bc2b3adcd1f"></a>
  410. <h2 class="memtitle"><span class="permalink"><a href="#aba35645c23735c4833c07bc2b3adcd1f">&#9670;&nbsp;</a></span>clusterCount()</h2>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="mlabels">
  414. <tr>
  415. <td class="mlabels-left">
  416. <table class="memname">
  417. <tr>
  418. <td class="memname">uint32_t FatPartition::clusterCount </td>
  419. <td>(</td>
  420. <td class="paramname"></td><td>)</td>
  421. <td> const</td>
  422. </tr>
  423. </table>
  424. </td>
  425. <td class="mlabels-right">
  426. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  431. </div>
  432. </div>
  433. <a id="a06acd4a434456b6a4644ff79a0bf0a24"></a>
  434. <h2 class="memtitle"><span class="permalink"><a href="#a06acd4a434456b6a4644ff79a0bf0a24">&#9670;&nbsp;</a></span>cwv()</h2>
  435. <div class="memitem">
  436. <div class="memproto">
  437. <table class="mlabels">
  438. <tr>
  439. <td class="mlabels-left">
  440. <table class="memname">
  441. <tr>
  442. <td class="memname">static <a class="el" href="class_fat_volume.html">FatVolume</a>* FatVolume::cwv </td>
  443. <td>(</td>
  444. <td class="paramname"></td><td>)</td>
  445. <td></td>
  446. </tr>
  447. </table>
  448. </td>
  449. <td class="mlabels-right">
  450. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  451. </tr>
  452. </table>
  453. </div><div class="memdoc">
  454. <dl class="section return"><dt>Returns</dt><dd>current working volume. </dd></dl>
  455. </div>
  456. </div>
  457. <a id="a7e89ec91780f7dfa060b261c605bf2e5"></a>
  458. <h2 class="memtitle"><span class="permalink"><a href="#a7e89ec91780f7dfa060b261c605bf2e5">&#9670;&nbsp;</a></span>dataStartSector()</h2>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="mlabels">
  462. <tr>
  463. <td class="mlabels-left">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname">uint32_t FatPartition::dataStartSector </td>
  467. <td>(</td>
  468. <td class="paramname"></td><td>)</td>
  469. <td> const</td>
  470. </tr>
  471. </table>
  472. </td>
  473. <td class="mlabels-right">
  474. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>
  479. </div>
  480. </div>
  481. <a id="a0af1e91a311180119b4a2c85d7e6e87e"></a>
  482. <h2 class="memtitle"><span class="permalink"><a href="#a0af1e91a311180119b4a2c85d7e6e87e">&#9670;&nbsp;</a></span>dbgFat()</h2>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="mlabels">
  486. <tr>
  487. <td class="mlabels-left">
  488. <table class="memname">
  489. <tr>
  490. <td class="memname">int8_t FatPartition::dbgFat </td>
  491. <td>(</td>
  492. <td class="paramtype">uint32_t&#160;</td>
  493. <td class="paramname"><em>n</em>, </td>
  494. </tr>
  495. <tr>
  496. <td class="paramkey"></td>
  497. <td></td>
  498. <td class="paramtype">uint32_t *&#160;</td>
  499. <td class="paramname"><em>v</em>&#160;</td>
  500. </tr>
  501. <tr>
  502. <td></td>
  503. <td>)</td>
  504. <td></td><td></td>
  505. </tr>
  506. </table>
  507. </td>
  508. <td class="mlabels-right">
  509. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  510. </tr>
  511. </table>
  512. </div><div class="memdoc">
  513. <p>Debug access to FAT table</p>
  514. <dl class="params"><dt>Parameters</dt><dd>
  515. <table class="params">
  516. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  517. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  518. </table>
  519. </dd>
  520. </dl>
  521. <dl class="section return"><dt>Returns</dt><dd>-1 error, 0 EOC, else 1. </dd></dl>
  522. </div>
  523. </div>
  524. <a id="a21541734ad76f64ea24b9f45e2bd6117"></a>
  525. <h2 class="memtitle"><span class="permalink"><a href="#a21541734ad76f64ea24b9f45e2bd6117">&#9670;&nbsp;</a></span>exists()</h2>
  526. <div class="memitem">
  527. <div class="memproto">
  528. <table class="mlabels">
  529. <tr>
  530. <td class="mlabels-left">
  531. <table class="memname">
  532. <tr>
  533. <td class="memname">bool FatVolume::exists </td>
  534. <td>(</td>
  535. <td class="paramtype">const char *&#160;</td>
  536. <td class="paramname"><em>path</em></td><td>)</td>
  537. <td></td>
  538. </tr>
  539. </table>
  540. </td>
  541. <td class="mlabels-right">
  542. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  543. </tr>
  544. </table>
  545. </div><div class="memdoc">
  546. <p>Test for the existence of a file.</p>
  547. <dl class="params"><dt>Parameters</dt><dd>
  548. <table class="params">
  549. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  550. </table>
  551. </dd>
  552. </dl>
  553. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  554. </div>
  555. </div>
  556. <a id="a56b37c3230818b9ae8e0a25c01a370a3"></a>
  557. <h2 class="memtitle"><span class="permalink"><a href="#a56b37c3230818b9ae8e0a25c01a370a3">&#9670;&nbsp;</a></span>fatCount()</h2>
  558. <div class="memitem">
  559. <div class="memproto">
  560. <table class="mlabels">
  561. <tr>
  562. <td class="mlabels-left">
  563. <table class="memname">
  564. <tr>
  565. <td class="memname">uint8_t FatPartition::fatCount </td>
  566. <td>(</td>
  567. <td class="paramname"></td><td>)</td>
  568. <td></td>
  569. </tr>
  570. </table>
  571. </td>
  572. <td class="mlabels-right">
  573. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  574. </tr>
  575. </table>
  576. </div><div class="memdoc">
  577. <dl class="section return"><dt>Returns</dt><dd>The number of File Allocation Tables. </dd></dl>
  578. </div>
  579. </div>
  580. <a id="a6a1ce7d707cf15bea08b63216413e055"></a>
  581. <h2 class="memtitle"><span class="permalink"><a href="#a6a1ce7d707cf15bea08b63216413e055">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  582. <div class="memitem">
  583. <div class="memproto">
  584. <table class="mlabels">
  585. <tr>
  586. <td class="mlabels-left">
  587. <table class="memname">
  588. <tr>
  589. <td class="memname">uint32_t FatPartition::fatStartSector </td>
  590. <td>(</td>
  591. <td class="paramname"></td><td>)</td>
  592. <td> const</td>
  593. </tr>
  594. </table>
  595. </td>
  596. <td class="mlabels-right">
  597. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  598. </tr>
  599. </table>
  600. </div><div class="memdoc">
  601. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>
  602. </div>
  603. </div>
  604. <a id="ad45c276232d7093b82f1075e8c488bac"></a>
  605. <h2 class="memtitle"><span class="permalink"><a href="#ad45c276232d7093b82f1075e8c488bac">&#9670;&nbsp;</a></span>fatType()</h2>
  606. <div class="memitem">
  607. <div class="memproto">
  608. <table class="mlabels">
  609. <tr>
  610. <td class="mlabels-left">
  611. <table class="memname">
  612. <tr>
  613. <td class="memname">uint8_t FatPartition::fatType </td>
  614. <td>(</td>
  615. <td class="paramname"></td><td>)</td>
  616. <td> const</td>
  617. </tr>
  618. </table>
  619. </td>
  620. <td class="mlabels-right">
  621. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  626. </div>
  627. </div>
  628. <a id="ac9689f1e11f59acc5f1b21ed9bb71174"></a>
  629. <h2 class="memtitle"><span class="permalink"><a href="#ac9689f1e11f59acc5f1b21ed9bb71174">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  630. <div class="memitem">
  631. <div class="memproto">
  632. <table class="mlabels">
  633. <tr>
  634. <td class="mlabels-left">
  635. <table class="memname">
  636. <tr>
  637. <td class="memname">int32_t FatPartition::freeClusterCount </td>
  638. <td>(</td>
  639. <td class="paramname"></td><td>)</td>
  640. <td></td>
  641. </tr>
  642. </table>
  643. </td>
  644. <td class="mlabels-right">
  645. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  646. </tr>
  647. </table>
  648. </div><div class="memdoc">
  649. <p>Volume free space in clusters.</p>
  650. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  651. </div>
  652. </div>
  653. <a id="ab827224f30eec57255d21cae589911ef"></a>
  654. <h2 class="memtitle"><span class="permalink"><a href="#ab827224f30eec57255d21cae589911ef">&#9670;&nbsp;</a></span>init()</h2>
  655. <div class="memitem">
  656. <div class="memproto">
  657. <table class="mlabels">
  658. <tr>
  659. <td class="mlabels-left">
  660. <table class="memname">
  661. <tr>
  662. <td class="memname">bool FatPartition::init </td>
  663. <td>(</td>
  664. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  665. <td class="paramname"><em>dev</em>, </td>
  666. </tr>
  667. <tr>
  668. <td class="paramkey"></td>
  669. <td></td>
  670. <td class="paramtype">uint8_t&#160;</td>
  671. <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>
  672. </tr>
  673. <tr>
  674. <td></td>
  675. <td>)</td>
  676. <td></td><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 partition.</p>
  686. <dl class="params"><dt>Parameters</dt><dd>
  687. <table class="params">
  688. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>BlockDevice for this partition. </td></tr>
  689. <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>
  690. </table>
  691. </dd>
  692. </dl>
  693. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  694. </div>
  695. </div>
  696. <a id="ae40964f357cfff4208812344a0e6f26f"></a>
  697. <h2 class="memtitle"><span class="permalink"><a href="#ae40964f357cfff4208812344a0e6f26f">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/2]</span></h2>
  698. <div class="memitem">
  699. <div class="memproto">
  700. <table class="mlabels">
  701. <tr>
  702. <td class="mlabels-left">
  703. <table class="memname">
  704. <tr>
  705. <td class="memname">bool FatVolume::ls </td>
  706. <td>(</td>
  707. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  708. <td class="paramname"><em>pr</em>, </td>
  709. </tr>
  710. <tr>
  711. <td class="paramkey"></td>
  712. <td></td>
  713. <td class="paramtype">uint8_t&#160;</td>
  714. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  715. </tr>
  716. <tr>
  717. <td></td>
  718. <td>)</td>
  719. <td></td><td></td>
  720. </tr>
  721. </table>
  722. </td>
  723. <td class="mlabels-right">
  724. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  725. </tr>
  726. </table>
  727. </div><div class="memdoc">
  728. <p>List the directory contents of the volume root directory.</p>
  729. <dl class="params"><dt>Parameters</dt><dd>
  730. <table class="params">
  731. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  732. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  733. </table>
  734. </dd>
  735. </dl>
  736. <p>LS_DATE - Print file modification date</p>
  737. <p>LS_SIZE - Print file size.</p>
  738. <p>LS_R - Recursive list of subdirectories.</p>
  739. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  740. </div>
  741. </div>
  742. <a id="ac5fc83cac7fd3af0b140a7986b9472f8"></a>
  743. <h2 class="memtitle"><span class="permalink"><a href="#ac5fc83cac7fd3af0b140a7986b9472f8">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/2]</span></h2>
  744. <div class="memitem">
  745. <div class="memproto">
  746. <table class="mlabels">
  747. <tr>
  748. <td class="mlabels-left">
  749. <table class="memname">
  750. <tr>
  751. <td class="memname">bool FatVolume::ls </td>
  752. <td>(</td>
  753. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  754. <td class="paramname"><em>pr</em>, </td>
  755. </tr>
  756. <tr>
  757. <td class="paramkey"></td>
  758. <td></td>
  759. <td class="paramtype">const char *&#160;</td>
  760. <td class="paramname"><em>path</em>, </td>
  761. </tr>
  762. <tr>
  763. <td class="paramkey"></td>
  764. <td></td>
  765. <td class="paramtype">uint8_t&#160;</td>
  766. <td class="paramname"><em>flags</em>&#160;</td>
  767. </tr>
  768. <tr>
  769. <td></td>
  770. <td>)</td>
  771. <td></td><td></td>
  772. </tr>
  773. </table>
  774. </td>
  775. <td class="mlabels-right">
  776. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  777. </tr>
  778. </table>
  779. </div><div class="memdoc">
  780. <p>List the contents of a directory.</p>
  781. <dl class="params"><dt>Parameters</dt><dd>
  782. <table class="params">
  783. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  784. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  785. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  786. </table>
  787. </dd>
  788. </dl>
  789. <p>LS_DATE - Print file modification date</p>
  790. <p>LS_SIZE - Print file size.</p>
  791. <p>LS_R - Recursive list of subdirectories.</p>
  792. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  793. </div>
  794. </div>
  795. <a id="ad80bccf8f24ff001a7b9277effc2cc52"></a>
  796. <h2 class="memtitle"><span class="permalink"><a href="#ad80bccf8f24ff001a7b9277effc2cc52">&#9670;&nbsp;</a></span>mkdir()</h2>
  797. <div class="memitem">
  798. <div class="memproto">
  799. <table class="mlabels">
  800. <tr>
  801. <td class="mlabels-left">
  802. <table class="memname">
  803. <tr>
  804. <td class="memname">bool FatVolume::mkdir </td>
  805. <td>(</td>
  806. <td class="paramtype">const char *&#160;</td>
  807. <td class="paramname"><em>path</em>, </td>
  808. </tr>
  809. <tr>
  810. <td class="paramkey"></td>
  811. <td></td>
  812. <td class="paramtype">bool&#160;</td>
  813. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  814. </tr>
  815. <tr>
  816. <td></td>
  817. <td>)</td>
  818. <td></td><td></td>
  819. </tr>
  820. </table>
  821. </td>
  822. <td class="mlabels-right">
  823. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  824. </tr>
  825. </table>
  826. </div><div class="memdoc">
  827. <p>Make a subdirectory in the volume root directory.</p>
  828. <dl class="params"><dt>Parameters</dt><dd>
  829. <table class="params">
  830. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  831. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  832. </table>
  833. </dd>
  834. </dl>
  835. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  836. </div>
  837. </div>
  838. <a id="a22923b86de9c797ce5e19f206dd4ce1f"></a>
  839. <h2 class="memtitle"><span class="permalink"><a href="#a22923b86de9c797ce5e19f206dd4ce1f">&#9670;&nbsp;</a></span>open()</h2>
  840. <div class="memitem">
  841. <div class="memproto">
  842. <table class="mlabels">
  843. <tr>
  844. <td class="mlabels-left">
  845. <table class="memname">
  846. <tr>
  847. <td class="memname"><a class="el" href="class_file32.html">File32</a> FatVolume::open </td>
  848. <td>(</td>
  849. <td class="paramtype">const char *&#160;</td>
  850. <td class="paramname"><em>path</em>, </td>
  851. </tr>
  852. <tr>
  853. <td class="paramkey"></td>
  854. <td></td>
  855. <td class="paramtype">oflag_t&#160;</td>
  856. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  857. </tr>
  858. <tr>
  859. <td></td>
  860. <td>)</td>
  861. <td></td><td></td>
  862. </tr>
  863. </table>
  864. </td>
  865. <td class="mlabels-right">
  866. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  867. </tr>
  868. </table>
  869. </div><div class="memdoc">
  870. <p>open a file</p>
  871. <dl class="params"><dt>Parameters</dt><dd>
  872. <table class="params">
  873. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  874. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  875. </table>
  876. </dd>
  877. </dl>
  878. <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>
  879. </div>
  880. </div>
  881. <a id="abb11d05ef407775bcdb9b14a6c608433"></a>
  882. <h2 class="memtitle"><span class="permalink"><a href="#abb11d05ef407775bcdb9b14a6c608433">&#9670;&nbsp;</a></span>remove()</h2>
  883. <div class="memitem">
  884. <div class="memproto">
  885. <table class="mlabels">
  886. <tr>
  887. <td class="mlabels-left">
  888. <table class="memname">
  889. <tr>
  890. <td class="memname">bool FatVolume::remove </td>
  891. <td>(</td>
  892. <td class="paramtype">const char *&#160;</td>
  893. <td class="paramname"><em>path</em></td><td>)</td>
  894. <td></td>
  895. </tr>
  896. </table>
  897. </td>
  898. <td class="mlabels-right">
  899. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  900. </tr>
  901. </table>
  902. </div><div class="memdoc">
  903. <p>Remove a file from the volume root directory.</p>
  904. <dl class="params"><dt>Parameters</dt><dd>
  905. <table class="params">
  906. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file.</td></tr>
  907. </table>
  908. </dd>
  909. </dl>
  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="a5e4ea6c91569dc435c7aacd7ba704911"></a>
  914. <h2 class="memtitle"><span class="permalink"><a href="#a5e4ea6c91569dc435c7aacd7ba704911">&#9670;&nbsp;</a></span>rename()</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::rename </td>
  923. <td>(</td>
  924. <td class="paramtype">const char *&#160;</td>
  925. <td class="paramname"><em>oldPath</em>, </td>
  926. </tr>
  927. <tr>
  928. <td class="paramkey"></td>
  929. <td></td>
  930. <td class="paramtype">const char *&#160;</td>
  931. <td class="paramname"><em>newPath</em>&#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>Rename a file or subdirectory.</p>
  946. <dl class="params"><dt>Parameters</dt><dd>
  947. <table class="params">
  948. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  949. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  950. </table>
  951. </dd>
  952. </dl>
  953. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  954. <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>
  955. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  956. </div>
  957. </div>
  958. <a id="af1181990bcece7dbb7d19293dd4fe11a"></a>
  959. <h2 class="memtitle"><span class="permalink"><a href="#af1181990bcece7dbb7d19293dd4fe11a">&#9670;&nbsp;</a></span>rmdir()</h2>
  960. <div class="memitem">
  961. <div class="memproto">
  962. <table class="mlabels">
  963. <tr>
  964. <td class="mlabels-left">
  965. <table class="memname">
  966. <tr>
  967. <td class="memname">bool FatVolume::rmdir </td>
  968. <td>(</td>
  969. <td class="paramtype">const char *&#160;</td>
  970. <td class="paramname"><em>path</em></td><td>)</td>
  971. <td></td>
  972. </tr>
  973. </table>
  974. </td>
  975. <td class="mlabels-right">
  976. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  977. </tr>
  978. </table>
  979. </div><div class="memdoc">
  980. <p>Remove a subdirectory from the volume's working directory.</p>
  981. <dl class="params"><dt>Parameters</dt><dd>
  982. <table class="params">
  983. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the subdirectory.</td></tr>
  984. </table>
  985. </dd>
  986. </dl>
  987. <p>The subdirectory file will be removed only if it is empty.</p>
  988. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  989. </div>
  990. </div>
  991. <a id="a6ba99b9711269b5ab6ca091b88e81288"></a>
  992. <h2 class="memtitle"><span class="permalink"><a href="#a6ba99b9711269b5ab6ca091b88e81288">&#9670;&nbsp;</a></span>rootDirEntryCount()</h2>
  993. <div class="memitem">
  994. <div class="memproto">
  995. <table class="mlabels">
  996. <tr>
  997. <td class="mlabels-left">
  998. <table class="memname">
  999. <tr>
  1000. <td class="memname">uint16_t FatPartition::rootDirEntryCount </td>
  1001. <td>(</td>
  1002. <td class="paramname"></td><td>)</td>
  1003. <td> const</td>
  1004. </tr>
  1005. </table>
  1006. </td>
  1007. <td class="mlabels-right">
  1008. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1009. </tr>
  1010. </table>
  1011. </div><div class="memdoc">
  1012. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  1013. </div>
  1014. </div>
  1015. <a id="a5d005e0f6fd4b84da8a5ebdea03aaf85"></a>
  1016. <h2 class="memtitle"><span class="permalink"><a href="#a5d005e0f6fd4b84da8a5ebdea03aaf85">&#9670;&nbsp;</a></span>rootDirStart()</h2>
  1017. <div class="memitem">
  1018. <div class="memproto">
  1019. <table class="mlabels">
  1020. <tr>
  1021. <td class="mlabels-left">
  1022. <table class="memname">
  1023. <tr>
  1024. <td class="memname">uint32_t FatPartition::rootDirStart </td>
  1025. <td>(</td>
  1026. <td class="paramname"></td><td>)</td>
  1027. <td> const</td>
  1028. </tr>
  1029. </table>
  1030. </td>
  1031. <td class="mlabels-right">
  1032. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1033. </tr>
  1034. </table>
  1035. </div><div class="memdoc">
  1036. <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>
  1037. </div>
  1038. </div>
  1039. <a id="a6b970fa2e06de1a826b09e251dc3119b"></a>
  1040. <h2 class="memtitle"><span class="permalink"><a href="#a6b970fa2e06de1a826b09e251dc3119b">&#9670;&nbsp;</a></span>sectorMask()</h2>
  1041. <div class="memitem">
  1042. <div class="memproto">
  1043. <table class="mlabels">
  1044. <tr>
  1045. <td class="mlabels-left">
  1046. <table class="memname">
  1047. <tr>
  1048. <td class="memname">uint16_t FatPartition::sectorMask </td>
  1049. <td>(</td>
  1050. <td class="paramname"></td><td>)</td>
  1051. <td></td>
  1052. </tr>
  1053. </table>
  1054. </td>
  1055. <td class="mlabels-right">
  1056. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1057. </tr>
  1058. </table>
  1059. </div><div class="memdoc">
  1060. <dl class="section return"><dt>Returns</dt><dd>Mask for sector offset. </dd></dl>
  1061. </div>
  1062. </div>
  1063. <a id="a836546c368e6ffe117e6ab8775d23eba"></a>
  1064. <h2 class="memtitle"><span class="permalink"><a href="#a836546c368e6ffe117e6ab8775d23eba">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  1065. <div class="memitem">
  1066. <div class="memproto">
  1067. <table class="mlabels">
  1068. <tr>
  1069. <td class="mlabels-left">
  1070. <table class="memname">
  1071. <tr>
  1072. <td class="memname">uint8_t FatPartition::sectorsPerCluster </td>
  1073. <td>(</td>
  1074. <td class="paramname"></td><td>)</td>
  1075. <td> const</td>
  1076. </tr>
  1077. </table>
  1078. </td>
  1079. <td class="mlabels-right">
  1080. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1081. </tr>
  1082. </table>
  1083. </div><div class="memdoc">
  1084. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>
  1085. </div>
  1086. </div>
  1087. <a id="a593a27482ff8d993542d6f82bd92e26c"></a>
  1088. <h2 class="memtitle"><span class="permalink"><a href="#a593a27482ff8d993542d6f82bd92e26c">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>
  1089. <div class="memitem">
  1090. <div class="memproto">
  1091. <table class="mlabels">
  1092. <tr>
  1093. <td class="mlabels-left">
  1094. <table class="memname">
  1095. <tr>
  1096. <td class="memname">uint8_t FatPartition::sectorsPerClusterShift </td>
  1097. <td>(</td>
  1098. <td class="paramname"></td><td>)</td>
  1099. <td> const</td>
  1100. </tr>
  1101. </table>
  1102. </td>
  1103. <td class="mlabels-right">
  1104. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1105. </tr>
  1106. </table>
  1107. </div><div class="memdoc">
  1108. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by sectorsPerCluster. </dd></dl>
  1109. </div>
  1110. </div>
  1111. <a id="a1f5c7599333dbe152a3cdd60623ce6d1"></a>
  1112. <h2 class="memtitle"><span class="permalink"><a href="#a1f5c7599333dbe152a3cdd60623ce6d1">&#9670;&nbsp;</a></span>sectorsPerFat()</h2>
  1113. <div class="memitem">
  1114. <div class="memproto">
  1115. <table class="mlabels">
  1116. <tr>
  1117. <td class="mlabels-left">
  1118. <table class="memname">
  1119. <tr>
  1120. <td class="memname">uint32_t FatPartition::sectorsPerFat </td>
  1121. <td>(</td>
  1122. <td class="paramname"></td><td>)</td>
  1123. <td> const</td>
  1124. </tr>
  1125. </table>
  1126. </td>
  1127. <td class="mlabels-right">
  1128. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1129. </tr>
  1130. </table>
  1131. </div><div class="memdoc">
  1132. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in one FAT. </dd></dl>
  1133. </div>
  1134. </div>
  1135. <a id="a86a08bf789e33567418465b9b12751e2"></a>
  1136. <h2 class="memtitle"><span class="permalink"><a href="#a86a08bf789e33567418465b9b12751e2">&#9670;&nbsp;</a></span>truncate()</h2>
  1137. <div class="memitem">
  1138. <div class="memproto">
  1139. <table class="mlabels">
  1140. <tr>
  1141. <td class="mlabels-left">
  1142. <table class="memname">
  1143. <tr>
  1144. <td class="memname">bool FatVolume::truncate </td>
  1145. <td>(</td>
  1146. <td class="paramtype">const char *&#160;</td>
  1147. <td class="paramname"><em>path</em>, </td>
  1148. </tr>
  1149. <tr>
  1150. <td class="paramkey"></td>
  1151. <td></td>
  1152. <td class="paramtype">uint32_t&#160;</td>
  1153. <td class="paramname"><em>length</em>&#160;</td>
  1154. </tr>
  1155. <tr>
  1156. <td></td>
  1157. <td>)</td>
  1158. <td></td><td></td>
  1159. </tr>
  1160. </table>
  1161. </td>
  1162. <td class="mlabels-right">
  1163. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1164. </tr>
  1165. </table>
  1166. </div><div class="memdoc">
  1167. <p>Truncate a file to a specified length. The current file position will be at the new EOF.</p>
  1168. <dl class="params"><dt>Parameters</dt><dd>
  1169. <table class="params">
  1170. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid name for the file. </td></tr>
  1171. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  1172. </table>
  1173. </dd>
  1174. </dl>
  1175. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  1176. </div>
  1177. </div>
  1178. <a id="a916ba7d67711bb62daf12ecd47ca4b8e"></a>
  1179. <h2 class="memtitle"><span class="permalink"><a href="#a916ba7d67711bb62daf12ecd47ca4b8e">&#9670;&nbsp;</a></span>volumeSectorCount()</h2>
  1180. <div class="memitem">
  1181. <div class="memproto">
  1182. <table class="mlabels">
  1183. <tr>
  1184. <td class="mlabels-left">
  1185. <table class="memname">
  1186. <tr>
  1187. <td class="memname">uint32_t FatPartition::volumeSectorCount </td>
  1188. <td>(</td>
  1189. <td class="paramname"></td><td>)</td>
  1190. <td> const</td>
  1191. </tr>
  1192. </table>
  1193. </td>
  1194. <td class="mlabels-right">
  1195. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1196. </tr>
  1197. </table>
  1198. </div><div class="memdoc">
  1199. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in the volume </dd></dl>
  1200. </div>
  1201. </div>
  1202. <hr/>The documentation for this class was generated from the following files:<ul>
  1203. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_volume_8h.html">FatVolume.h</a></li>
  1204. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatVolume.cpp</li>
  1205. </ul>
  1206. </div><!-- contents -->
  1207. <!-- start footer part -->
  1208. <hr class="footer"/><address class="footer"><small>
  1209. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  1210. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1211. </a> 1.8.14
  1212. </small></address>
  1213. </body>
  1214. </html>