You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

888 line
38KB

  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: FsVolume 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="#friends">Friends</a> &#124;
  66. <a href="class_fs_volume-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">FsVolume Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><a class="el" href="class_fs_volume.html" title="FsVolume class. ">FsVolume</a> class.
  72. <a href="class_fs_volume.html#details">More...</a></p>
  73. <p><code>#include &lt;FsVolume.h&gt;</code></p>
  74. <div class="dynheader">
  75. Inheritance diagram for FsVolume:</div>
  76. <div class="dyncontent">
  77. <div class="center"><img src="class_fs_volume__inherit__graph.png" border="0" usemap="#_fs_volume_inherit__map" alt="Inheritance graph"/></div>
  78. <map name="_fs_volume_inherit__map" id="_fs_volume_inherit__map">
  79. <area shape="rect" id="node2" href="class_sd_base.html" title="SdBase\&lt; FsVolume \&gt;" alt="" coords="5,80,156,107"/>
  80. <area shape="rect" id="node3" href="class_sd_fs.html" title="SD file system class for FAT16, FAT32, and exFAT volumes. " alt="" coords="54,155,107,181"/>
  81. </map>
  82. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  85. Public Member Functions</h2></td></tr>
  86. <tr class="memitem:ae587e7c114b0af86ec0b2927300133b0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#ae587e7c114b0af86ec0b2927300133b0">begin</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *blockDev)</td></tr>
  87. <tr class="separator:ae587e7c114b0af86ec0b2927300133b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a770e0dca5ed7f8d3ca63768da38042cb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a770e0dca5ed7f8d3ca63768da38042cb">bytesPerCluster</a> ()</td></tr>
  89. <tr class="separator:a770e0dca5ed7f8d3ca63768da38042cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:abcc645df09441d40c476e4981393c944"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#abcc645df09441d40c476e4981393c944">chdir</a> ()</td></tr>
  91. <tr class="separator:abcc645df09441d40c476e4981393c944"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ac4f62724d5eeaec3582594bb3b4c3e65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#ac4f62724d5eeaec3582594bb3b4c3e65">chdir</a> (const char *path)</td></tr>
  93. <tr class="separator:ac4f62724d5eeaec3582594bb3b4c3e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a34a5bb7a97a081a7d74cf297f1fbee82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a34a5bb7a97a081a7d74cf297f1fbee82">chvol</a> ()</td></tr>
  95. <tr class="separator:a34a5bb7a97a081a7d74cf297f1fbee82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:abc9731fa79598460a37f10a2e561f29c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#abc9731fa79598460a37f10a2e561f29c">clusterCount</a> ()</td></tr>
  97. <tr class="separator:abc9731fa79598460a37f10a2e561f29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a79cebeb23cb3cdaa06550475fe24272a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a79cebeb23cb3cdaa06550475fe24272a">dataStartSector</a> () const</td></tr>
  99. <tr class="separator:a79cebeb23cb3cdaa06550475fe24272a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:acd5a0e50a30334785d75a8c8bfc3e1f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#acd5a0e50a30334785d75a8c8bfc3e1f9">end</a> ()</td></tr>
  101. <tr class="separator:acd5a0e50a30334785d75a8c8bfc3e1f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a9bece771399c97b136868f684c2b4496"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a9bece771399c97b136868f684c2b4496">exists</a> (const char *path)</td></tr>
  103. <tr class="separator:a9bece771399c97b136868f684c2b4496"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ac5f4de35d2bfdd65bc38c2562b147a26"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#ac5f4de35d2bfdd65bc38c2562b147a26">fatStartSector</a> () const</td></tr>
  105. <tr class="separator:ac5f4de35d2bfdd65bc38c2562b147a26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ad26b5c171ca4c6e953cfbdbfe0b9a988"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#ad26b5c171ca4c6e953cfbdbfe0b9a988">fatType</a> () const</td></tr>
  107. <tr class="separator:ad26b5c171ca4c6e953cfbdbfe0b9a988"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:af6dbe47dfe11adf752df95c351b10fdd"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#af6dbe47dfe11adf752df95c351b10fdd">freeClusterCount</a> ()</td></tr>
  109. <tr class="separator:af6dbe47dfe11adf752df95c351b10fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a679105032aa3e5c4585c63f8e7acfc02"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a679105032aa3e5c4585c63f8e7acfc02">ls</a> (<a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr)</td></tr>
  111. <tr class="separator:a679105032aa3e5c4585c63f8e7acfc02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a5ce82e5970856d1e8d549c512ec8a253"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a5ce82e5970856d1e8d549c512ec8a253">ls</a> (<a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, uint8_t flags)</td></tr>
  113. <tr class="separator:a5ce82e5970856d1e8d549c512ec8a253"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ab429316ed9e57a52ecfb938aca7dff6c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#ab429316ed9e57a52ecfb938aca7dff6c">ls</a> (<a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  115. <tr class="separator:ab429316ed9e57a52ecfb938aca7dff6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a9d38c297dccceeb5f48dceb17232368d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a9d38c297dccceeb5f48dceb17232368d">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  117. <tr class="separator:a9d38c297dccceeb5f48dceb17232368d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a2f28fc92b7a71607bc57aa72f5a4c0a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fs_file.html">FsFile</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a2f28fc92b7a71607bc57aa72f5a4c0a7">open</a> (const char *path, oflag_t oflag=0X00)</td></tr>
  119. <tr class="separator:a2f28fc92b7a71607bc57aa72f5a4c0a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aaaa53cfc48602b3d1524508944bd112e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#aaaa53cfc48602b3d1524508944bd112e">remove</a> (const char *path)</td></tr>
  121. <tr class="separator:aaaa53cfc48602b3d1524508944bd112e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:aae3be08aff89f5a113cfa0b89c4a6004"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#aae3be08aff89f5a113cfa0b89c4a6004">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  123. <tr class="separator:aae3be08aff89f5a113cfa0b89c4a6004"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ad2457b491bf85495140fd4a8ca743513"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#ad2457b491bf85495140fd4a8ca743513">rmdir</a> (const char *path)</td></tr>
  125. <tr class="separator:ad2457b491bf85495140fd4a8ca743513"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:acf62acd37d3f59dedd3e34b3e7d64da0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#acf62acd37d3f59dedd3e34b3e7d64da0">sectorsPerCluster</a> () const</td></tr>
  127. <tr class="separator:acf62acd37d3f59dedd3e34b3e7d64da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table><table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  130. Static Public Member Functions</h2></td></tr>
  131. <tr class="memitem:ab4fa0f21669b84e00d00fd54c3144a8f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_fs_volume.html">FsVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#ab4fa0f21669b84e00d00fd54c3144a8f">cwv</a> ()</td></tr>
  132. <tr class="separator:ab4fa0f21669b84e00d00fd54c3144a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table><table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  135. Friends</h2></td></tr>
  136. <tr class="memitem:a1655636bca63e3ac7e7ab6a8d112a2f0"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fs_volume.html#a1655636bca63e3ac7e7ab6a8d112a2f0">FsBaseFile</a></td></tr>
  137. <tr class="separator:a1655636bca63e3ac7e7ab6a8d112a2f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table>
  139. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  140. <div class="textblock"><p><a class="el" href="class_fs_volume.html" title="FsVolume class. ">FsVolume</a> class. </p>
  141. </div><h2 class="groupheader">Member Function Documentation</h2>
  142. <a id="ae587e7c114b0af86ec0b2927300133b0"></a>
  143. <h2 class="memtitle"><span class="permalink"><a href="#ae587e7c114b0af86ec0b2927300133b0">&#9670;&nbsp;</a></span>begin()</h2>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">bool FsVolume::begin </td>
  149. <td>(</td>
  150. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  151. <td class="paramname"><em>blockDev</em></td><td>)</td>
  152. <td></td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <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>
  157. <table class="params">
  158. <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>
  159. </table>
  160. </dd>
  161. </dl>
  162. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  163. </div>
  164. </div>
  165. <a id="a770e0dca5ed7f8d3ca63768da38042cb"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#a770e0dca5ed7f8d3ca63768da38042cb">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="mlabels">
  170. <tr>
  171. <td class="mlabels-left">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">uint32_t FsVolume::bytesPerCluster </td>
  175. <td>(</td>
  176. <td class="paramname"></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a cluster. </dd></dl>
  187. </div>
  188. </div>
  189. <a id="abcc645df09441d40c476e4981393c944"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#abcc645df09441d40c476e4981393c944">&#9670;&nbsp;</a></span>chdir() <span class="overload">[1/2]</span></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 FsVolume::chdir </td>
  199. <td>(</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <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>
  211. </div>
  212. </div>
  213. <a id="ac4f62724d5eeaec3582594bb3b4c3e65"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#ac4f62724d5eeaec3582594bb3b4c3e65">&#9670;&nbsp;</a></span>chdir() <span class="overload">[2/2]</span></h2>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="mlabels">
  218. <tr>
  219. <td class="mlabels-left">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">bool FsVolume::chdir </td>
  223. <td>(</td>
  224. <td class="paramtype">const char *&#160;</td>
  225. <td class="paramname"><em>path</em></td><td>)</td>
  226. <td></td>
  227. </tr>
  228. </table>
  229. </td>
  230. <td class="mlabels-right">
  231. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. <p>Set volume working directory. </p><dl class="params"><dt>Parameters</dt><dd>
  236. <table class="params">
  237. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path for volume working directory. </td></tr>
  238. </table>
  239. </dd>
  240. </dl>
  241. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  242. </div>
  243. </div>
  244. <a id="a34a5bb7a97a081a7d74cf297f1fbee82"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#a34a5bb7a97a081a7d74cf297f1fbee82">&#9670;&nbsp;</a></span>chvol()</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">void FsVolume::chvol </td>
  254. <td>(</td>
  255. <td class="paramname"></td><td>)</td>
  256. <td></td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Change global working volume to this volume. </p>
  266. </div>
  267. </div>
  268. <a id="abc9731fa79598460a37f10a2e561f29c"></a>
  269. <h2 class="memtitle"><span class="permalink"><a href="#abc9731fa79598460a37f10a2e561f29c">&#9670;&nbsp;</a></span>clusterCount()</h2>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="mlabels">
  273. <tr>
  274. <td class="mlabels-left">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname">uint32_t FsVolume::clusterCount </td>
  278. <td>(</td>
  279. <td class="paramname"></td><td>)</td>
  280. <td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  290. </div>
  291. </div>
  292. <a id="ab4fa0f21669b84e00d00fd54c3144a8f"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#ab4fa0f21669b84e00d00fd54c3144a8f">&#9670;&nbsp;</a></span>cwv()</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="mlabels">
  297. <tr>
  298. <td class="mlabels-left">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">static <a class="el" href="class_fs_volume.html">FsVolume</a>* FsVolume::cwv </td>
  302. <td>(</td>
  303. <td class="paramname"></td><td>)</td>
  304. <td></td>
  305. </tr>
  306. </table>
  307. </td>
  308. <td class="mlabels-right">
  309. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <dl class="section return"><dt>Returns</dt><dd>current working volume. </dd></dl>
  314. </div>
  315. </div>
  316. <a id="a79cebeb23cb3cdaa06550475fe24272a"></a>
  317. <h2 class="memtitle"><span class="permalink"><a href="#a79cebeb23cb3cdaa06550475fe24272a">&#9670;&nbsp;</a></span>dataStartSector()</h2>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="mlabels">
  321. <tr>
  322. <td class="mlabels-left">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">uint32_t FsVolume::dataStartSector </td>
  326. <td>(</td>
  327. <td class="paramname"></td><td>)</td>
  328. <td> const</td>
  329. </tr>
  330. </table>
  331. </td>
  332. <td class="mlabels-right">
  333. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>
  338. </div>
  339. </div>
  340. <a id="acd5a0e50a30334785d75a8c8bfc3e1f9"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#acd5a0e50a30334785d75a8c8bfc3e1f9">&#9670;&nbsp;</a></span>end()</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="mlabels">
  345. <tr>
  346. <td class="mlabels-left">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">void FsVolume::end </td>
  350. <td>(</td>
  351. <td class="paramname"></td><td>)</td>
  352. <td></td>
  353. </tr>
  354. </table>
  355. </td>
  356. <td class="mlabels-right">
  357. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <p>free dynamic memory and end access to volume </p>
  362. </div>
  363. </div>
  364. <a id="a9bece771399c97b136868f684c2b4496"></a>
  365. <h2 class="memtitle"><span class="permalink"><a href="#a9bece771399c97b136868f684c2b4496">&#9670;&nbsp;</a></span>exists()</h2>
  366. <div class="memitem">
  367. <div class="memproto">
  368. <table class="mlabels">
  369. <tr>
  370. <td class="mlabels-left">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">bool FsVolume::exists </td>
  374. <td>(</td>
  375. <td class="paramtype">const char *&#160;</td>
  376. <td class="paramname"><em>path</em></td><td>)</td>
  377. <td></td>
  378. </tr>
  379. </table>
  380. </td>
  381. <td class="mlabels-right">
  382. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <p>Test for the existence of a file in a directory</p>
  387. <dl class="params"><dt>Parameters</dt><dd>
  388. <table class="params">
  389. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  390. </table>
  391. </dd>
  392. </dl>
  393. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  394. </div>
  395. </div>
  396. <a id="ac5f4de35d2bfdd65bc38c2562b147a26"></a>
  397. <h2 class="memtitle"><span class="permalink"><a href="#ac5f4de35d2bfdd65bc38c2562b147a26">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  398. <div class="memitem">
  399. <div class="memproto">
  400. <table class="mlabels">
  401. <tr>
  402. <td class="mlabels-left">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname">uint32_t FsVolume::fatStartSector </td>
  406. <td>(</td>
  407. <td class="paramname"></td><td>)</td>
  408. <td> const</td>
  409. </tr>
  410. </table>
  411. </td>
  412. <td class="mlabels-right">
  413. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  414. </tr>
  415. </table>
  416. </div><div class="memdoc">
  417. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>
  418. </div>
  419. </div>
  420. <a id="ad26b5c171ca4c6e953cfbdbfe0b9a988"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#ad26b5c171ca4c6e953cfbdbfe0b9a988">&#9670;&nbsp;</a></span>fatType()</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="mlabels">
  425. <tr>
  426. <td class="mlabels-left">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">uint8_t FsVolume::fatType </td>
  430. <td>(</td>
  431. <td class="paramname"></td><td>)</td>
  432. <td> const</td>
  433. </tr>
  434. </table>
  435. </td>
  436. <td class="mlabels-right">
  437. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <dl class="section return"><dt>Returns</dt><dd>Partition type, FAT_TYPE_EXFAT, FAT_TYPE_FAT32, FAT_TYPE_FAT16, or zero for error. </dd></dl>
  442. </div>
  443. </div>
  444. <a id="af6dbe47dfe11adf752df95c351b10fdd"></a>
  445. <h2 class="memtitle"><span class="permalink"><a href="#af6dbe47dfe11adf752df95c351b10fdd">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  446. <div class="memitem">
  447. <div class="memproto">
  448. <table class="mlabels">
  449. <tr>
  450. <td class="mlabels-left">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">uint32_t FsVolume::freeClusterCount </td>
  454. <td>(</td>
  455. <td class="paramname"></td><td>)</td>
  456. <td></td>
  457. </tr>
  458. </table>
  459. </td>
  460. <td class="mlabels-right">
  461. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  462. </tr>
  463. </table>
  464. </div><div class="memdoc">
  465. <dl class="section return"><dt>Returns</dt><dd>the free cluster count. </dd></dl>
  466. </div>
  467. </div>
  468. <a id="a679105032aa3e5c4585c63f8e7acfc02"></a>
  469. <h2 class="memtitle"><span class="permalink"><a href="#a679105032aa3e5c4585c63f8e7acfc02">&#9670;&nbsp;</a></span>ls() <span class="overload">[1/3]</span></h2>
  470. <div class="memitem">
  471. <div class="memproto">
  472. <table class="mlabels">
  473. <tr>
  474. <td class="mlabels-left">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname">bool FsVolume::ls </td>
  478. <td>(</td>
  479. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  480. <td class="paramname"><em>pr</em></td><td>)</td>
  481. <td></td>
  482. </tr>
  483. </table>
  484. </td>
  485. <td class="mlabels-right">
  486. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  487. </tr>
  488. </table>
  489. </div><div class="memdoc">
  490. <p>List directory contents.</p>
  491. <dl class="params"><dt>Parameters</dt><dd>
  492. <table class="params">
  493. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object.</td></tr>
  494. </table>
  495. </dd>
  496. </dl>
  497. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  498. </div>
  499. </div>
  500. <a id="a5ce82e5970856d1e8d549c512ec8a253"></a>
  501. <h2 class="memtitle"><span class="permalink"><a href="#a5ce82e5970856d1e8d549c512ec8a253">&#9670;&nbsp;</a></span>ls() <span class="overload">[2/3]</span></h2>
  502. <div class="memitem">
  503. <div class="memproto">
  504. <table class="mlabels">
  505. <tr>
  506. <td class="mlabels-left">
  507. <table class="memname">
  508. <tr>
  509. <td class="memname">bool FsVolume::ls </td>
  510. <td>(</td>
  511. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  512. <td class="paramname"><em>pr</em>, </td>
  513. </tr>
  514. <tr>
  515. <td class="paramkey"></td>
  516. <td></td>
  517. <td class="paramtype">uint8_t&#160;</td>
  518. <td class="paramname"><em>flags</em>&#160;</td>
  519. </tr>
  520. <tr>
  521. <td></td>
  522. <td>)</td>
  523. <td></td><td></td>
  524. </tr>
  525. </table>
  526. </td>
  527. <td class="mlabels-right">
  528. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  529. </tr>
  530. </table>
  531. </div><div class="memdoc">
  532. <p>List directory contents.</p>
  533. <dl class="params"><dt>Parameters</dt><dd>
  534. <table class="params">
  535. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print object. </td></tr>
  536. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  537. </table>
  538. </dd>
  539. </dl>
  540. <p>LS_DATE - Print file modification date</p>
  541. <p>LS_SIZE - Print file size.</p>
  542. <p>LS_R - Recursive list of subdirectories.</p>
  543. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  544. </div>
  545. </div>
  546. <a id="ab429316ed9e57a52ecfb938aca7dff6c"></a>
  547. <h2 class="memtitle"><span class="permalink"><a href="#ab429316ed9e57a52ecfb938aca7dff6c">&#9670;&nbsp;</a></span>ls() <span class="overload">[3/3]</span></h2>
  548. <div class="memitem">
  549. <div class="memproto">
  550. <table class="memname">
  551. <tr>
  552. <td class="memname">bool FsVolume::ls </td>
  553. <td>(</td>
  554. <td class="paramtype"><a class="el" href="_sys_call_8h.html#ab4f210a7e2149c6c531486f1713c647b">print_t</a> *&#160;</td>
  555. <td class="paramname"><em>pr</em>, </td>
  556. </tr>
  557. <tr>
  558. <td class="paramkey"></td>
  559. <td></td>
  560. <td class="paramtype">const char *&#160;</td>
  561. <td class="paramname"><em>path</em>, </td>
  562. </tr>
  563. <tr>
  564. <td class="paramkey"></td>
  565. <td></td>
  566. <td class="paramtype">uint8_t&#160;</td>
  567. <td class="paramname"><em>flags</em>&#160;</td>
  568. </tr>
  569. <tr>
  570. <td></td>
  571. <td>)</td>
  572. <td></td><td></td>
  573. </tr>
  574. </table>
  575. </div><div class="memdoc">
  576. <p>List the directory contents of a directory.</p>
  577. <dl class="params"><dt>Parameters</dt><dd>
  578. <table class="params">
  579. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  580. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  581. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  582. </table>
  583. </dd>
  584. </dl>
  585. <p>LS_DATE - Print file modification date</p>
  586. <p>LS_SIZE - Print file size.</p>
  587. <p>LS_R - Recursive list of subdirectories.</p>
  588. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  589. </div>
  590. </div>
  591. <a id="a9d38c297dccceeb5f48dceb17232368d"></a>
  592. <h2 class="memtitle"><span class="permalink"><a href="#a9d38c297dccceeb5f48dceb17232368d">&#9670;&nbsp;</a></span>mkdir()</h2>
  593. <div class="memitem">
  594. <div class="memproto">
  595. <table class="mlabels">
  596. <tr>
  597. <td class="mlabels-left">
  598. <table class="memname">
  599. <tr>
  600. <td class="memname">bool FsVolume::mkdir </td>
  601. <td>(</td>
  602. <td class="paramtype">const char *&#160;</td>
  603. <td class="paramname"><em>path</em>, </td>
  604. </tr>
  605. <tr>
  606. <td class="paramkey"></td>
  607. <td></td>
  608. <td class="paramtype">bool&#160;</td>
  609. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  610. </tr>
  611. <tr>
  612. <td></td>
  613. <td>)</td>
  614. <td></td><td></td>
  615. </tr>
  616. </table>
  617. </td>
  618. <td class="mlabels-right">
  619. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  620. </tr>
  621. </table>
  622. </div><div class="memdoc">
  623. <p>Make a subdirectory in the volume root directory.</p>
  624. <dl class="params"><dt>Parameters</dt><dd>
  625. <table class="params">
  626. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  627. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  628. </table>
  629. </dd>
  630. </dl>
  631. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  632. </div>
  633. </div>
  634. <a id="a2f28fc92b7a71607bc57aa72f5a4c0a7"></a>
  635. <h2 class="memtitle"><span class="permalink"><a href="#a2f28fc92b7a71607bc57aa72f5a4c0a7">&#9670;&nbsp;</a></span>open()</h2>
  636. <div class="memitem">
  637. <div class="memproto">
  638. <table class="memname">
  639. <tr>
  640. <td class="memname"><a class="el" href="class_fs_file.html">FsFile</a> FsVolume::open </td>
  641. <td>(</td>
  642. <td class="paramtype">const char *&#160;</td>
  643. <td class="paramname"><em>path</em>, </td>
  644. </tr>
  645. <tr>
  646. <td class="paramkey"></td>
  647. <td></td>
  648. <td class="paramtype">oflag_t&#160;</td>
  649. <td class="paramname"><em>oflag</em> = <code>0X00</code>&#160;</td>
  650. </tr>
  651. <tr>
  652. <td></td>
  653. <td>)</td>
  654. <td></td><td></td>
  655. </tr>
  656. </table>
  657. </div><div class="memdoc">
  658. <p>open a file</p>
  659. <dl class="params"><dt>Parameters</dt><dd>
  660. <table class="params">
  661. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  662. <tr><td class="paramdir">[in]</td><td class="paramname">oflag</td><td>open flags. </td></tr>
  663. </table>
  664. </dd>
  665. </dl>
  666. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_fs_base_file.html" title="FsBaseFile class. ">FsBaseFile</a> object. </dd></dl>
  667. </div>
  668. </div>
  669. <a id="aaaa53cfc48602b3d1524508944bd112e"></a>
  670. <h2 class="memtitle"><span class="permalink"><a href="#aaaa53cfc48602b3d1524508944bd112e">&#9670;&nbsp;</a></span>remove()</h2>
  671. <div class="memitem">
  672. <div class="memproto">
  673. <table class="mlabels">
  674. <tr>
  675. <td class="mlabels-left">
  676. <table class="memname">
  677. <tr>
  678. <td class="memname">bool FsVolume::remove </td>
  679. <td>(</td>
  680. <td class="paramtype">const char *&#160;</td>
  681. <td class="paramname"><em>path</em></td><td>)</td>
  682. <td></td>
  683. </tr>
  684. </table>
  685. </td>
  686. <td class="mlabels-right">
  687. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  688. </tr>
  689. </table>
  690. </div><div class="memdoc">
  691. <p>Remove a file from the volume root directory.</p>
  692. <dl class="params"><dt>Parameters</dt><dd>
  693. <table class="params">
  694. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the file.</td></tr>
  695. </table>
  696. </dd>
  697. </dl>
  698. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  699. </div>
  700. </div>
  701. <a id="aae3be08aff89f5a113cfa0b89c4a6004"></a>
  702. <h2 class="memtitle"><span class="permalink"><a href="#aae3be08aff89f5a113cfa0b89c4a6004">&#9670;&nbsp;</a></span>rename()</h2>
  703. <div class="memitem">
  704. <div class="memproto">
  705. <table class="mlabels">
  706. <tr>
  707. <td class="mlabels-left">
  708. <table class="memname">
  709. <tr>
  710. <td class="memname">bool FsVolume::rename </td>
  711. <td>(</td>
  712. <td class="paramtype">const char *&#160;</td>
  713. <td class="paramname"><em>oldPath</em>, </td>
  714. </tr>
  715. <tr>
  716. <td class="paramkey"></td>
  717. <td></td>
  718. <td class="paramtype">const char *&#160;</td>
  719. <td class="paramname"><em>newPath</em>&#160;</td>
  720. </tr>
  721. <tr>
  722. <td></td>
  723. <td>)</td>
  724. <td></td><td></td>
  725. </tr>
  726. </table>
  727. </td>
  728. <td class="mlabels-right">
  729. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  730. </tr>
  731. </table>
  732. </div><div class="memdoc">
  733. <p>Rename a file or subdirectory.</p>
  734. <dl class="params"><dt>Parameters</dt><dd>
  735. <table class="params">
  736. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  737. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  738. </table>
  739. </dd>
  740. </dl>
  741. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  742. <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_fs_volume.html#aae3be08aff89f5a113cfa0b89c4a6004">rename()</a> call.</p>
  743. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  744. </div>
  745. </div>
  746. <a id="ad2457b491bf85495140fd4a8ca743513"></a>
  747. <h2 class="memtitle"><span class="permalink"><a href="#ad2457b491bf85495140fd4a8ca743513">&#9670;&nbsp;</a></span>rmdir()</h2>
  748. <div class="memitem">
  749. <div class="memproto">
  750. <table class="mlabels">
  751. <tr>
  752. <td class="mlabels-left">
  753. <table class="memname">
  754. <tr>
  755. <td class="memname">bool FsVolume::rmdir </td>
  756. <td>(</td>
  757. <td class="paramtype">const char *&#160;</td>
  758. <td class="paramname"><em>path</em></td><td>)</td>
  759. <td></td>
  760. </tr>
  761. </table>
  762. </td>
  763. <td class="mlabels-right">
  764. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  765. </tr>
  766. </table>
  767. </div><div class="memdoc">
  768. <p>Remove a subdirectory from the volume's root directory.</p>
  769. <dl class="params"><dt>Parameters</dt><dd>
  770. <table class="params">
  771. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path with a valid 8.3 DOS name for the subdirectory.</td></tr>
  772. </table>
  773. </dd>
  774. </dl>
  775. <p>The subdirectory file will be removed only if it is empty.</p>
  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="acf62acd37d3f59dedd3e34b3e7d64da0"></a>
  780. <h2 class="memtitle"><span class="permalink"><a href="#acf62acd37d3f59dedd3e34b3e7d64da0">&#9670;&nbsp;</a></span>sectorsPerCluster()</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">uint32_t FsVolume::sectorsPerCluster </td>
  789. <td>(</td>
  790. <td class="paramname"></td><td>)</td>
  791. <td> const</td>
  792. </tr>
  793. </table>
  794. </td>
  795. <td class="mlabels-right">
  796. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  797. </tr>
  798. </table>
  799. </div><div class="memdoc">
  800. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>
  801. </div>
  802. </div>
  803. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  804. <a id="a1655636bca63e3ac7e7ab6a8d112a2f0"></a>
  805. <h2 class="memtitle"><span class="permalink"><a href="#a1655636bca63e3ac7e7ab6a8d112a2f0">&#9670;&nbsp;</a></span>FsBaseFile</h2>
  806. <div class="memitem">
  807. <div class="memproto">
  808. <table class="mlabels">
  809. <tr>
  810. <td class="mlabels-left">
  811. <table class="memname">
  812. <tr>
  813. <td class="memname">friend class <a class="el" href="class_fs_base_file.html">FsBaseFile</a></td>
  814. </tr>
  815. </table>
  816. </td>
  817. <td class="mlabels-right">
  818. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  819. </tr>
  820. </table>
  821. </div><div class="memdoc">
  822. <p><a class="el" href="class_fs_base_file.html" title="FsBaseFile class. ">FsBaseFile</a> allowed access to private members. </p>
  823. </div>
  824. </div>
  825. <hr/>The documentation for this class was generated from the following files:<ul>
  826. <li>ArduinoSdFat/libraries/SdFat/src/FsLib/<a class="el" href="_fs_volume_8h.html">FsVolume.h</a></li>
  827. <li>ArduinoSdFat/libraries/SdFat/src/FsLib/FsVolume.cpp</li>
  828. </ul>
  829. </div><!-- contents -->
  830. <!-- start footer part -->
  831. <hr class="footer"/><address class="footer"><small>
  832. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  833. <img class="footer" src="doxygen.png" alt="doxygen"/>
  834. </a> 1.8.14
  835. </small></address>
  836. </body>
  837. </html>