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.

2345 line
99KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>SdFat: SdFileSystem&lt; SdDriverClass &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">SdFat
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  65. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#pub-methods">Public Member Functions</a> &#124;
  84. <a href="class_sd_file_system-members.html">List of all members</a> </div>
  85. <div class="headertitle">
  86. <div class="title">SdFileSystem&lt; SdDriverClass &gt; Class Template Reference</div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <p>Virtual base class for SdFat library.
  90. <a href="class_sd_file_system.html#details">More...</a></p>
  91. <p><code>#include &lt;SdFat.h&gt;</code></p>
  92. <div class="dynheader">
  93. Inheritance diagram for SdFileSystem&lt; SdDriverClass &gt;:</div>
  94. <div class="dyncontent">
  95. <div class="center"><img src="class_sd_file_system__inherit__graph.png" border="0" usemap="#_sd_file_system_3_01_sd_driver_class_01_4_inherit__map" alt="Inheritance graph"/></div>
  96. <map name="_sd_file_system_3_01_sd_driver_class_01_4_inherit__map" id="_sd_file_system_3_01_sd_driver_class_01_4_inherit__map">
  97. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="57,80,163,107"/>
  98. <area shape="rect" id="node3" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="67,5,153,32"/>
  99. </map>
  100. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  101. <div class="dynheader">
  102. Collaboration diagram for SdFileSystem&lt; SdDriverClass &gt;:</div>
  103. <div class="dyncontent">
  104. <div class="center"><img src="class_sd_file_system__coll__graph.png" border="0" usemap="#_sd_file_system_3_01_sd_driver_class_01_4_coll__map" alt="Collaboration graph"/></div>
  105. <map name="_sd_file_system_3_01_sd_driver_class_01_4_coll__map" id="_sd_file_system_3_01_sd_driver_class_01_4_coll__map">
  106. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="57,80,163,107"/>
  107. <area shape="rect" id="node3" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="67,5,153,32"/>
  108. </map>
  109. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  110. <table class="memberdecls">
  111. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  112. Public Member Functions</h2></td></tr>
  113. <tr class="memitem:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5dda20d3dcbfc8c641babbb2c9aac382">begin</a> (<a class="el" href="_block_driver_8h.html#ace97f2377acdc471a01f9f7ec1fd6bbb">BlockDriver</a> *blockDev, uint8_t part=0)</td></tr>
  114. <tr class="separator:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ad94237ef45c52698e97b04e8c131f21e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin</a> ()</td></tr>
  116. <tr class="separator:ad94237ef45c52698e97b04e8c131f21e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a06beed4cea5e38116b58254a57125442"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a06beed4cea5e38116b58254a57125442">blocksPerCluster</a> () const </td></tr>
  118. <tr class="separator:a06beed4cea5e38116b58254a57125442"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:abc66d856d05198d9ebe7104c8c4155d7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#abc66d856d05198d9ebe7104c8c4155d7">blocksPerFat</a> () const </td></tr>
  120. <tr class="separator:abc66d856d05198d9ebe7104c8c4155d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioncache__t.html">cache_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#aa1e3b1d0c21d202deb82668068ab00e8">cacheClear</a> ()</td></tr>
  122. <tr class="separator:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ab5dcfbeeb7caa38a38db86003341eb07"><td class="memItemLeft" align="right" valign="top">SdDriverClass *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab5dcfbeeb7caa38a38db86003341eb07">card</a> ()</td></tr>
  124. <tr class="separator:ab5dcfbeeb7caa38a38db86003341eb07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:aedfd5a0830c955bc5514e52f2f2dd066"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#aedfd5a0830c955bc5514e52f2f2dd066">cardErrorCode</a> ()</td></tr>
  126. <tr class="separator:aedfd5a0830c955bc5514e52f2f2dd066"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a0602ab3c04ea33293649f0a15fc81e05"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a0602ab3c04ea33293649f0a15fc81e05">cardErrorData</a> ()</td></tr>
  128. <tr class="separator:a0602ab3c04ea33293649f0a15fc81e05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a5667915e63187a43a71dfada63800865"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5667915e63187a43a71dfada63800865">chdir</a> (bool set_cwd=false)</td></tr>
  130. <tr class="separator:a5667915e63187a43a71dfada63800865"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a44af1b98e8d986d12107b654453acbc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a44af1b98e8d986d12107b654453acbc4">chdir</a> (const char *path, bool set_cwd=false)</td></tr>
  132. <tr class="separator:a44af1b98e8d986d12107b654453acbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:af24917d6e00c8766dab168eb834047ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#af24917d6e00c8766dab168eb834047ec">chvol</a> ()</td></tr>
  134. <tr class="separator:af24917d6e00c8766dab168eb834047ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a18446a9c5924304fa7a87d5f03ccaf21">clusterCount</a> () const </td></tr>
  136. <tr class="separator:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ac0e63f33d71d5dc95a602834274def6a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac0e63f33d71d5dc95a602834274def6a">clusterSizeShift</a> () const </td></tr>
  138. <tr class="separator:ac0e63f33d71d5dc95a602834274def6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a443364af257c219f8e908d5b073d8fa3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a443364af257c219f8e908d5b073d8fa3">dataStartBlock</a> () const </td></tr>
  140. <tr class="separator:a443364af257c219f8e908d5b073d8fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a25c6311b70fa274b3be94ff25fdebba7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a25c6311b70fa274b3be94ff25fdebba7">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  142. <tr class="separator:a25c6311b70fa274b3be94ff25fdebba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a855267374306bfee2df67642c99d4d18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a855267374306bfee2df67642c99d4d18">errorHalt</a> ()</td></tr>
  144. <tr class="separator:a855267374306bfee2df67642c99d4d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ae1f79a2974ebe134e70f898c32d97e98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ae1f79a2974ebe134e70f898c32d97e98">errorHalt</a> (Print *pr)</td></tr>
  146. <tr class="separator:ae1f79a2974ebe134e70f898c32d97e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a32c20dfa6a8cb8af95f25847b19bdbca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a32c20dfa6a8cb8af95f25847b19bdbca">errorHalt</a> (char const *msg)</td></tr>
  148. <tr class="separator:a32c20dfa6a8cb8af95f25847b19bdbca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a27fb329d6aee79a63c20386218ce7e9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a27fb329d6aee79a63c20386218ce7e9e">errorHalt</a> (Print *pr, char const *msg)</td></tr>
  150. <tr class="separator:a27fb329d6aee79a63c20386218ce7e9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:af856494745a9842d9728dfeabf19c51e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#af856494745a9842d9728dfeabf19c51e">errorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  152. <tr class="separator:af856494745a9842d9728dfeabf19c51e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a746c80d048c30baf0b281e16932670a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a746c80d048c30baf0b281e16932670a2">errorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  154. <tr class="separator:a746c80d048c30baf0b281e16932670a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ab0b78154d6874c29279ba81f36ccb09c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab0b78154d6874c29279ba81f36ccb09c">errorPrint</a> ()</td></tr>
  156. <tr class="separator:ab0b78154d6874c29279ba81f36ccb09c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a03736274debea71fef5e2ff34d7ec3dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a03736274debea71fef5e2ff34d7ec3dc">errorPrint</a> (Print *pr)</td></tr>
  158. <tr class="separator:a03736274debea71fef5e2ff34d7ec3dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a2e2436b7b2666737cbaf4b22218bc69f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a2e2436b7b2666737cbaf4b22218bc69f">errorPrint</a> (const char *msg)</td></tr>
  160. <tr class="separator:a2e2436b7b2666737cbaf4b22218bc69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a0eb6b92a0700ba932f6127962981d153"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a0eb6b92a0700ba932f6127962981d153">errorPrint</a> (Print *pr, char const *msg)</td></tr>
  162. <tr class="separator:a0eb6b92a0700ba932f6127962981d153"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a1ccb1f937f42e9c1331c942bc357f6da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a1ccb1f937f42e9c1331c942bc357f6da">errorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  164. <tr class="separator:a1ccb1f937f42e9c1331c942bc357f6da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a43344a079d9af92ea4b550914d0512f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a43344a079d9af92ea4b550914d0512f6">errorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  166. <tr class="separator:a43344a079d9af92ea4b550914d0512f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:aee58c6352652f216577196e32a594b67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aee58c6352652f216577196e32a594b67">exists</a> (const char *path)</td></tr>
  168. <tr class="separator:aee58c6352652f216577196e32a594b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acdedc6a200b01e401c9cd9b511eae6ec">fatCount</a> ()</td></tr>
  170. <tr class="separator:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a0dd0cc689b63ef0702aed1cf36b1722d">fatStartBlock</a> () const </td></tr>
  172. <tr class="separator:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1364f11fe9bb4717ce0685e2b7b86027">fatType</a> () const </td></tr>
  174. <tr class="separator:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a1683b063fc6202ab85470b9610f16f93"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1683b063fc6202ab85470b9610f16f93">freeClusterCount</a> ()</td></tr>
  176. <tr class="separator:a1683b063fc6202ab85470b9610f16f93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">init</a> ()</td></tr>
  178. <tr class="separator:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a034d997a1e7a0b2b664a4357bcccd256"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a034d997a1e7a0b2b664a4357bcccd256">init</a> (uint8_t part)</td></tr>
  180. <tr class="separator:a034d997a1e7a0b2b664a4357bcccd256"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a8e1f26486bb878a24fa9868e59dbbbc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a8e1f26486bb878a24fa9868e59dbbbc2">initErrorHalt</a> ()</td></tr>
  182. <tr class="separator:a8e1f26486bb878a24fa9868e59dbbbc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:a24bd0f699cf0fe11fd2148b15c49251a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a24bd0f699cf0fe11fd2148b15c49251a">initErrorHalt</a> (Print *pr)</td></tr>
  184. <tr class="separator:a24bd0f699cf0fe11fd2148b15c49251a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:a893833a880e2a83757480ba4c1351041"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a893833a880e2a83757480ba4c1351041">initErrorHalt</a> (char const *msg)</td></tr>
  186. <tr class="separator:a893833a880e2a83757480ba4c1351041"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a3077b1a53d789d0401b707963cb28f46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a3077b1a53d789d0401b707963cb28f46">initErrorHalt</a> (Print *pr, char const *msg)</td></tr>
  188. <tr class="separator:a3077b1a53d789d0401b707963cb28f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a2a1e4cc8056ba23b55dfa2c6486b8798"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a2a1e4cc8056ba23b55dfa2c6486b8798">initErrorHalt</a> (const __FlashStringHelper *msg)</td></tr>
  190. <tr class="separator:a2a1e4cc8056ba23b55dfa2c6486b8798"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:ab03d98012dea18733c3252f27832de69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab03d98012dea18733c3252f27832de69">initErrorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  192. <tr class="separator:ab03d98012dea18733c3252f27832de69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:ae31c9cbd7e1c03129d6c99b25f73cd50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ae31c9cbd7e1c03129d6c99b25f73cd50">initErrorPrint</a> ()</td></tr>
  194. <tr class="separator:ae31c9cbd7e1c03129d6c99b25f73cd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:a066707dce0667213b5f083d59f67448d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a066707dce0667213b5f083d59f67448d">initErrorPrint</a> (Print *pr)</td></tr>
  196. <tr class="separator:a066707dce0667213b5f083d59f67448d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a538796f79fd9db9c5bbeefd9defe639a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a538796f79fd9db9c5bbeefd9defe639a">initErrorPrint</a> (char const *msg)</td></tr>
  198. <tr class="separator:a538796f79fd9db9c5bbeefd9defe639a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:ad9855d33ebd465715b706d0926291b13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad9855d33ebd465715b706d0926291b13">initErrorPrint</a> (Print *pr, char const *msg)</td></tr>
  200. <tr class="separator:ad9855d33ebd465715b706d0926291b13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:ad6ffec5a7d82be46d46b8a4f82d0803b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad6ffec5a7d82be46d46b8a4f82d0803b">initErrorPrint</a> (const __FlashStringHelper *msg)</td></tr>
  202. <tr class="separator:ad6ffec5a7d82be46d46b8a4f82d0803b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:a8a2018b6366145a9843d3d29a47d6560"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a8a2018b6366145a9843d3d29a47d6560">initErrorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>
  204. <tr class="separator:a8a2018b6366145a9843d3d29a47d6560"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a2398fb37a7a9d5e0dc0ffde6a44a993d">ls</a> (uint8_t flags=0)</td></tr>
  206. <tr class="separator:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:a122b61dbec5051304bcc81bc08b1b99d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a122b61dbec5051304bcc81bc08b1b99d">ls</a> (const char *path, uint8_t flags=0)</td></tr>
  208. <tr class="separator:a122b61dbec5051304bcc81bc08b1b99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="memitem:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ae12fb8bfad5c4a8e052dda70a5a0ed93">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>
  210. <tr class="separator:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:aa79695db8e910300507210b3067d39fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aa79695db8e910300507210b3067d39fd">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, const char *path, uint8_t flags)</td></tr>
  212. <tr class="separator:aa79695db8e910300507210b3067d39fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <tr class="memitem:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a231c62c98ba8ac3c2624dc5ad2053ebf">mkdir</a> (const char *path, bool pFlag=true)</td></tr>
  214. <tr class="separator:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  215. <tr class="memitem:a947e4586077a922892b632edac33b67a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a947e4586077a922892b632edac33b67a">open</a> (const char *path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  216. <tr class="separator:a947e4586077a922892b632edac33b67a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. <tr class="memitem:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0abfb1f754a8fb559cfa884ee040f56f">open</a> (const String &amp;path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>
  218. <tr class="separator:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  219. <tr class="memitem:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#abf7d7d0dab43083d5be10d70ff4669e4">remove</a> (const char *path)</td></tr>
  220. <tr class="separator:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  221. <tr class="memitem:a0187891a24017b41bd7c5ba63e659e65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename</a> (const char *oldPath, const char *newPath)</td></tr>
  222. <tr class="separator:a0187891a24017b41bd7c5ba63e659e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <tr class="memitem:aaed2edc7ff7fedb163458c870bb41b33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aaed2edc7ff7fedb163458c870bb41b33">rmdir</a> (const char *path)</td></tr>
  224. <tr class="separator:aaed2edc7ff7fedb163458c870bb41b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. <tr class="memitem:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab2d483670a0a6a6a4754b23614fe11bc">rootDirEntryCount</a> () const </td></tr>
  226. <tr class="separator:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  227. <tr class="memitem:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae9363ebbbae90e895ea56e8fa3f60c13">rootDirStart</a> () const </td></tr>
  228. <tr class="separator:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <tr class="memitem:ad60cb13557f35578f868e03e9ccb8be1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ad60cb13557f35578f868e03e9ccb8be1">truncate</a> (const char *path, uint32_t length)</td></tr>
  230. <tr class="separator:ad60cb13557f35578f868e03e9ccb8be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  231. <tr class="memitem:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a4ca68fe47bb675df0a80df1ed7a53698">vol</a> ()</td></tr>
  232. <tr class="separator:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memSeparator" colspan="2">&#160;</td></tr>
  233. <tr class="memitem:a07bc98088ce4a9c725700899c184f7fc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a07bc98088ce4a9c725700899c184f7fc">volumeBlockCount</a> () const </td></tr>
  234. <tr class="separator:a07bc98088ce4a9c725700899c184f7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  235. <tr class="memitem:acf257d02b7166683bda2abc5058004bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_fat_file.html">FatFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#acf257d02b7166683bda2abc5058004bf">vwd</a> ()</td></tr>
  236. <tr class="separator:acf257d02b7166683bda2abc5058004bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a36d7831f92acfbfef1c4a24dd7103dc4">wipe</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=0)</td></tr>
  238. <tr class="separator:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  239. </table>
  240. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  241. <div class="textblock"><h3>template&lt;class SdDriverClass&gt;<br />
  242. class SdFileSystem&lt; SdDriverClass &gt;</h3>
  243. <p>Virtual base class for SdFat library. </p>
  244. </div><h2 class="groupheader">Member Function Documentation</h2>
  245. <a class="anchor" id="a5dda20d3dcbfc8c641babbb2c9aac382"></a>
  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">bool FatFileSystem::begin </td>
  254. <td>(</td>
  255. <td class="paramtype"><a class="el" href="_block_driver_8h.html#ace97f2377acdc471a01f9f7ec1fd6bbb">BlockDriver</a> *&#160;</td>
  256. <td class="paramname"><em>blockDev</em>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype">uint8_t&#160;</td>
  262. <td class="paramname"><em>part</em> = <code>0</code>&#160;</td>
  263. </tr>
  264. <tr>
  265. <td></td>
  266. <td>)</td>
  267. <td></td><td></td>
  268. </tr>
  269. </table>
  270. </td>
  271. <td class="mlabels-right">
  272. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Initialize an <a class="el" href="class_fat_file_system.html" title="Integration class for the FatLib library. ">FatFileSystem</a> object. </p><dl class="params"><dt>Parameters</dt><dd>
  277. <table class="params">
  278. <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>
  279. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>
  280. </table>
  281. </dd>
  282. </dl>
  283. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  284. </div>
  285. </div>
  286. <a class="anchor" id="ad94237ef45c52698e97b04e8c131f21e"></a>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <div class="memtemplate">
  290. template&lt;class SdDriverClass&gt; </div>
  291. <table class="mlabels">
  292. <tr>
  293. <td class="mlabels-left">
  294. <table class="memname">
  295. <tr>
  296. <td class="memname">bool <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::begin </td>
  297. <td>(</td>
  298. <td class="paramname"></td><td>)</td>
  299. <td></td>
  300. </tr>
  301. </table>
  302. </td>
  303. <td class="mlabels-right">
  304. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Initialize file system. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  309. </div>
  310. </div>
  311. <a class="anchor" id="a06beed4cea5e38116b58254a57125442"></a>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="mlabels">
  315. <tr>
  316. <td class="mlabels-left">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">uint8_t FatVolume::blocksPerCluster </td>
  320. <td>(</td>
  321. <td class="paramname"></td><td>)</td>
  322. <td> const</td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>
  332. </div>
  333. </div>
  334. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></a>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="mlabels">
  338. <tr>
  339. <td class="mlabels-left">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname">uint32_t FatVolume::blocksPerFat </td>
  343. <td>(</td>
  344. <td class="paramname"></td><td>)</td>
  345. <td> const</td>
  346. </tr>
  347. </table>
  348. </td>
  349. <td class="mlabels-right">
  350. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  355. </div>
  356. </div>
  357. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></a>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="mlabels">
  361. <tr>
  362. <td class="mlabels-left">
  363. <table class="memname">
  364. <tr>
  365. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>
  366. <td>(</td>
  367. <td class="paramname"></td><td>)</td>
  368. <td></td>
  369. </tr>
  370. </table>
  371. </td>
  372. <td class="mlabels-right">
  373. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <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>
  378. </div>
  379. </div>
  380. <a class="anchor" id="ab5dcfbeeb7caa38a38db86003341eb07"></a>
  381. <div class="memitem">
  382. <div class="memproto">
  383. <div class="memtemplate">
  384. template&lt;class SdDriverClass&gt; </div>
  385. <table class="mlabels">
  386. <tr>
  387. <td class="mlabels-left">
  388. <table class="memname">
  389. <tr>
  390. <td class="memname">SdDriverClass* <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::card </td>
  391. <td>(</td>
  392. <td class="paramname"></td><td>)</td>
  393. <td></td>
  394. </tr>
  395. </table>
  396. </td>
  397. <td class="mlabels-right">
  398. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object </dd></dl>
  403. </div>
  404. </div>
  405. <a class="anchor" id="aedfd5a0830c955bc5514e52f2f2dd066"></a>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <div class="memtemplate">
  409. template&lt;class SdDriverClass&gt; </div>
  410. <table class="mlabels">
  411. <tr>
  412. <td class="mlabels-left">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">uint8_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::cardErrorCode </td>
  416. <td>(</td>
  417. <td class="paramname"></td><td>)</td>
  418. <td></td>
  419. </tr>
  420. </table>
  421. </td>
  422. <td class="mlabels-right">
  423. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <dl class="section return"><dt>Returns</dt><dd>The card error code </dd></dl>
  428. </div>
  429. </div>
  430. <a class="anchor" id="a0602ab3c04ea33293649f0a15fc81e05"></a>
  431. <div class="memitem">
  432. <div class="memproto">
  433. <div class="memtemplate">
  434. template&lt;class SdDriverClass&gt; </div>
  435. <table class="mlabels">
  436. <tr>
  437. <td class="mlabels-left">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">uint32_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::cardErrorData </td>
  441. <td>(</td>
  442. <td class="paramname"></td><td>)</td>
  443. <td></td>
  444. </tr>
  445. </table>
  446. </td>
  447. <td class="mlabels-right">
  448. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <dl class="section return"><dt>Returns</dt><dd>the card error data </dd></dl>
  453. </div>
  454. </div>
  455. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></a>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <table class="mlabels">
  459. <tr>
  460. <td class="mlabels-left">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname">bool FatFileSystem::chdir </td>
  464. <td>(</td>
  465. <td class="paramtype">bool&#160;</td>
  466. <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>
  467. <td></td>
  468. </tr>
  469. </table>
  470. </td>
  471. <td class="mlabels-right">
  472. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  473. </tr>
  474. </table>
  475. </div><div class="memdoc">
  476. <p>Change a volume's working directory to root</p>
  477. <p>Changes the volume's working directory to the SD's root directory. Optionally set the current working directory to the volume's working directory.</p>
  478. <dl class="params"><dt>Parameters</dt><dd>
  479. <table class="params">
  480. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  481. </table>
  482. </dd>
  483. </dl>
  484. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  485. </div>
  486. </div>
  487. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></a>
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="mlabels">
  491. <tr>
  492. <td class="mlabels-left">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">bool FatFileSystem::chdir </td>
  496. <td>(</td>
  497. <td class="paramtype">const char *&#160;</td>
  498. <td class="paramname"><em>path</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype">bool&#160;</td>
  504. <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>
  505. </tr>
  506. <tr>
  507. <td></td>
  508. <td>)</td>
  509. <td></td><td></td>
  510. </tr>
  511. </table>
  512. </td>
  513. <td class="mlabels-right">
  514. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  515. </tr>
  516. </table>
  517. </div><div class="memdoc">
  518. <p>Change a volume's working directory</p>
  519. <p>Changes the volume working directory to the <em>path</em> subdirectory. Optionally set the current working directory to the volume's working directory.</p>
  520. <p>Example: If the volume's working directory is "/DIR", chdir("SUB") will change the volume's working directory from "/DIR" to "/DIR/SUB".</p>
  521. <p>If path is "/", the volume's working directory will be changed to the root directory</p>
  522. <dl class="params"><dt>Parameters</dt><dd>
  523. <table class="params">
  524. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>
  525. <tr><td class="paramdir">[in]</td><td class="paramname">set_cwd</td><td>Set the current working directory to this volume's working directory if true.</td></tr>
  526. </table>
  527. </dd>
  528. </dl>
  529. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  530. </div>
  531. </div>
  532. <a class="anchor" id="af24917d6e00c8766dab168eb834047ec"></a>
  533. <div class="memitem">
  534. <div class="memproto">
  535. <table class="mlabels">
  536. <tr>
  537. <td class="mlabels-left">
  538. <table class="memname">
  539. <tr>
  540. <td class="memname">void FatFileSystem::chvol </td>
  541. <td>(</td>
  542. <td class="paramname"></td><td>)</td>
  543. <td></td>
  544. </tr>
  545. </table>
  546. </td>
  547. <td class="mlabels-right">
  548. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  549. </tr>
  550. </table>
  551. </div><div class="memdoc">
  552. <p>Set the current working directory to a volume's working directory.</p>
  553. <p>This is useful with multiple SD cards.</p>
  554. <p>The current working directory is changed to this volume's working directory.</p>
  555. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>
  556. </div>
  557. </div>
  558. <a class="anchor" id="a18446a9c5924304fa7a87d5f03ccaf21"></a>
  559. <div class="memitem">
  560. <div class="memproto">
  561. <table class="mlabels">
  562. <tr>
  563. <td class="mlabels-left">
  564. <table class="memname">
  565. <tr>
  566. <td class="memname">uint32_t FatVolume::clusterCount </td>
  567. <td>(</td>
  568. <td class="paramname"></td><td>)</td>
  569. <td> const</td>
  570. </tr>
  571. </table>
  572. </td>
  573. <td class="mlabels-right">
  574. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  575. </tr>
  576. </table>
  577. </div><div class="memdoc">
  578. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  579. </div>
  580. </div>
  581. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></a>
  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">uint8_t FatVolume::clusterSizeShift </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 shift count required to multiply by blocksPerCluster. </dd></dl>
  602. </div>
  603. </div>
  604. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></a>
  605. <div class="memitem">
  606. <div class="memproto">
  607. <table class="mlabels">
  608. <tr>
  609. <td class="mlabels-left">
  610. <table class="memname">
  611. <tr>
  612. <td class="memname">uint32_t FatVolume::dataStartBlock </td>
  613. <td>(</td>
  614. <td class="paramname"></td><td>)</td>
  615. <td> const</td>
  616. </tr>
  617. </table>
  618. </td>
  619. <td class="mlabels-right">
  620. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  621. </tr>
  622. </table>
  623. </div><div class="memdoc">
  624. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  625. </div>
  626. </div>
  627. <a class="anchor" id="a25c6311b70fa274b3be94ff25fdebba7"></a>
  628. <div class="memitem">
  629. <div class="memproto">
  630. <table class="mlabels">
  631. <tr>
  632. <td class="mlabels-left">
  633. <table class="memname">
  634. <tr>
  635. <td class="memname">int8_t FatVolume::dbgFat </td>
  636. <td>(</td>
  637. <td class="paramtype">uint32_t&#160;</td>
  638. <td class="paramname"><em>n</em>, </td>
  639. </tr>
  640. <tr>
  641. <td class="paramkey"></td>
  642. <td></td>
  643. <td class="paramtype">uint32_t *&#160;</td>
  644. <td class="paramname"><em>v</em>&#160;</td>
  645. </tr>
  646. <tr>
  647. <td></td>
  648. <td>)</td>
  649. <td></td><td></td>
  650. </tr>
  651. </table>
  652. </td>
  653. <td class="mlabels-right">
  654. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  655. </tr>
  656. </table>
  657. </div><div class="memdoc">
  658. <p>Debug access to FAT table</p>
  659. <dl class="params"><dt>Parameters</dt><dd>
  660. <table class="params">
  661. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  662. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  663. </table>
  664. </dd>
  665. </dl>
  666. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>
  667. </div>
  668. </div>
  669. <a class="anchor" id="a855267374306bfee2df67642c99d4d18"></a>
  670. <div class="memitem">
  671. <div class="memproto">
  672. <div class="memtemplate">
  673. template&lt;class SdDriverClass&gt; </div>
  674. <table class="mlabels">
  675. <tr>
  676. <td class="mlabels-left">
  677. <table class="memname">
  678. <tr>
  679. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>
  680. <td>(</td>
  681. <td class="paramname"></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>Print any SD error code to Serial and halt. </p>
  692. </div>
  693. </div>
  694. <a class="anchor" id="ae1f79a2974ebe134e70f898c32d97e98"></a>
  695. <div class="memitem">
  696. <div class="memproto">
  697. <div class="memtemplate">
  698. template&lt;class SdDriverClass&gt; </div>
  699. <table class="mlabels">
  700. <tr>
  701. <td class="mlabels-left">
  702. <table class="memname">
  703. <tr>
  704. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>
  705. <td>(</td>
  706. <td class="paramtype">Print *&#160;</td>
  707. <td class="paramname"><em>pr</em></td><td>)</td>
  708. <td></td>
  709. </tr>
  710. </table>
  711. </td>
  712. <td class="mlabels-right">
  713. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  714. </tr>
  715. </table>
  716. </div><div class="memdoc">
  717. <p>Print any SD error code and halt.</p>
  718. <dl class="params"><dt>Parameters</dt><dd>
  719. <table class="params">
  720. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  721. </table>
  722. </dd>
  723. </dl>
  724. </div>
  725. </div>
  726. <a class="anchor" id="a32c20dfa6a8cb8af95f25847b19bdbca"></a>
  727. <div class="memitem">
  728. <div class="memproto">
  729. <div class="memtemplate">
  730. template&lt;class SdDriverClass&gt; </div>
  731. <table class="mlabels">
  732. <tr>
  733. <td class="mlabels-left">
  734. <table class="memname">
  735. <tr>
  736. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>
  737. <td>(</td>
  738. <td class="paramtype">char const *&#160;</td>
  739. <td class="paramname"><em>msg</em></td><td>)</td>
  740. <td></td>
  741. </tr>
  742. </table>
  743. </td>
  744. <td class="mlabels-right">
  745. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  746. </tr>
  747. </table>
  748. </div><div class="memdoc">
  749. <p>Print msg, any SD error code and halt.</p>
  750. <dl class="params"><dt>Parameters</dt><dd>
  751. <table class="params">
  752. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  753. </table>
  754. </dd>
  755. </dl>
  756. </div>
  757. </div>
  758. <a class="anchor" id="a27fb329d6aee79a63c20386218ce7e9e"></a>
  759. <div class="memitem">
  760. <div class="memproto">
  761. <div class="memtemplate">
  762. template&lt;class SdDriverClass&gt; </div>
  763. <table class="mlabels">
  764. <tr>
  765. <td class="mlabels-left">
  766. <table class="memname">
  767. <tr>
  768. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>
  769. <td>(</td>
  770. <td class="paramtype">Print *&#160;</td>
  771. <td class="paramname"><em>pr</em>, </td>
  772. </tr>
  773. <tr>
  774. <td class="paramkey"></td>
  775. <td></td>
  776. <td class="paramtype">char const *&#160;</td>
  777. <td class="paramname"><em>msg</em>&#160;</td>
  778. </tr>
  779. <tr>
  780. <td></td>
  781. <td>)</td>
  782. <td></td><td></td>
  783. </tr>
  784. </table>
  785. </td>
  786. <td class="mlabels-right">
  787. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  788. </tr>
  789. </table>
  790. </div><div class="memdoc">
  791. <p>Print msg, any SD error code, and halt.</p>
  792. <dl class="params"><dt>Parameters</dt><dd>
  793. <table class="params">
  794. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  795. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  796. </table>
  797. </dd>
  798. </dl>
  799. </div>
  800. </div>
  801. <a class="anchor" id="af856494745a9842d9728dfeabf19c51e"></a>
  802. <div class="memitem">
  803. <div class="memproto">
  804. <div class="memtemplate">
  805. template&lt;class SdDriverClass&gt; </div>
  806. <table class="mlabels">
  807. <tr>
  808. <td class="mlabels-left">
  809. <table class="memname">
  810. <tr>
  811. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>
  812. <td>(</td>
  813. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  814. <td class="paramname"><em>msg</em></td><td>)</td>
  815. <td></td>
  816. </tr>
  817. </table>
  818. </td>
  819. <td class="mlabels-right">
  820. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  821. </tr>
  822. </table>
  823. </div><div class="memdoc">
  824. <p>Print msg, any SD error code, and halt.</p>
  825. <dl class="params"><dt>Parameters</dt><dd>
  826. <table class="params">
  827. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  828. </table>
  829. </dd>
  830. </dl>
  831. </div>
  832. </div>
  833. <a class="anchor" id="a746c80d048c30baf0b281e16932670a2"></a>
  834. <div class="memitem">
  835. <div class="memproto">
  836. <div class="memtemplate">
  837. template&lt;class SdDriverClass&gt; </div>
  838. <table class="mlabels">
  839. <tr>
  840. <td class="mlabels-left">
  841. <table class="memname">
  842. <tr>
  843. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorHalt </td>
  844. <td>(</td>
  845. <td class="paramtype">Print *&#160;</td>
  846. <td class="paramname"><em>pr</em>, </td>
  847. </tr>
  848. <tr>
  849. <td class="paramkey"></td>
  850. <td></td>
  851. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  852. <td class="paramname"><em>msg</em>&#160;</td>
  853. </tr>
  854. <tr>
  855. <td></td>
  856. <td>)</td>
  857. <td></td><td></td>
  858. </tr>
  859. </table>
  860. </td>
  861. <td class="mlabels-right">
  862. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  863. </tr>
  864. </table>
  865. </div><div class="memdoc">
  866. <p>Print msg, any SD error code, and halt.</p>
  867. <dl class="params"><dt>Parameters</dt><dd>
  868. <table class="params">
  869. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  870. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  871. </table>
  872. </dd>
  873. </dl>
  874. </div>
  875. </div>
  876. <a class="anchor" id="ab0b78154d6874c29279ba81f36ccb09c"></a>
  877. <div class="memitem">
  878. <div class="memproto">
  879. <div class="memtemplate">
  880. template&lt;class SdDriverClass&gt; </div>
  881. <table class="mlabels">
  882. <tr>
  883. <td class="mlabels-left">
  884. <table class="memname">
  885. <tr>
  886. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>
  887. <td>(</td>
  888. <td class="paramname"></td><td>)</td>
  889. <td></td>
  890. </tr>
  891. </table>
  892. </td>
  893. <td class="mlabels-right">
  894. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  895. </tr>
  896. </table>
  897. </div><div class="memdoc">
  898. <p>Print any SD error code to Serial </p>
  899. </div>
  900. </div>
  901. <a class="anchor" id="a03736274debea71fef5e2ff34d7ec3dc"></a>
  902. <div class="memitem">
  903. <div class="memproto">
  904. <div class="memtemplate">
  905. template&lt;class SdDriverClass&gt; </div>
  906. <table class="mlabels">
  907. <tr>
  908. <td class="mlabels-left">
  909. <table class="memname">
  910. <tr>
  911. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>
  912. <td>(</td>
  913. <td class="paramtype">Print *&#160;</td>
  914. <td class="paramname"><em>pr</em></td><td>)</td>
  915. <td></td>
  916. </tr>
  917. </table>
  918. </td>
  919. <td class="mlabels-right">
  920. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  921. </tr>
  922. </table>
  923. </div><div class="memdoc">
  924. <p>Print any SD error code. </p><dl class="params"><dt>Parameters</dt><dd>
  925. <table class="params">
  926. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  927. </table>
  928. </dd>
  929. </dl>
  930. </div>
  931. </div>
  932. <a class="anchor" id="a2e2436b7b2666737cbaf4b22218bc69f"></a>
  933. <div class="memitem">
  934. <div class="memproto">
  935. <div class="memtemplate">
  936. template&lt;class SdDriverClass&gt; </div>
  937. <table class="mlabels">
  938. <tr>
  939. <td class="mlabels-left">
  940. <table class="memname">
  941. <tr>
  942. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>
  943. <td>(</td>
  944. <td class="paramtype">const char *&#160;</td>
  945. <td class="paramname"><em>msg</em></td><td>)</td>
  946. <td></td>
  947. </tr>
  948. </table>
  949. </td>
  950. <td class="mlabels-right">
  951. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  952. </tr>
  953. </table>
  954. </div><div class="memdoc">
  955. <p>Print msg, any SD error code.</p>
  956. <dl class="params"><dt>Parameters</dt><dd>
  957. <table class="params">
  958. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  959. </table>
  960. </dd>
  961. </dl>
  962. </div>
  963. </div>
  964. <a class="anchor" id="a0eb6b92a0700ba932f6127962981d153"></a>
  965. <div class="memitem">
  966. <div class="memproto">
  967. <div class="memtemplate">
  968. template&lt;class SdDriverClass&gt; </div>
  969. <table class="mlabels">
  970. <tr>
  971. <td class="mlabels-left">
  972. <table class="memname">
  973. <tr>
  974. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>
  975. <td>(</td>
  976. <td class="paramtype">Print *&#160;</td>
  977. <td class="paramname"><em>pr</em>, </td>
  978. </tr>
  979. <tr>
  980. <td class="paramkey"></td>
  981. <td></td>
  982. <td class="paramtype">char const *&#160;</td>
  983. <td class="paramname"><em>msg</em>&#160;</td>
  984. </tr>
  985. <tr>
  986. <td></td>
  987. <td>)</td>
  988. <td></td><td></td>
  989. </tr>
  990. </table>
  991. </td>
  992. <td class="mlabels-right">
  993. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  994. </tr>
  995. </table>
  996. </div><div class="memdoc">
  997. <p>Print msg, any SD error code.</p>
  998. <dl class="params"><dt>Parameters</dt><dd>
  999. <table class="params">
  1000. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1001. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1002. </table>
  1003. </dd>
  1004. </dl>
  1005. </div>
  1006. </div>
  1007. <a class="anchor" id="a1ccb1f937f42e9c1331c942bc357f6da"></a>
  1008. <div class="memitem">
  1009. <div class="memproto">
  1010. <div class="memtemplate">
  1011. template&lt;class SdDriverClass&gt; </div>
  1012. <table class="mlabels">
  1013. <tr>
  1014. <td class="mlabels-left">
  1015. <table class="memname">
  1016. <tr>
  1017. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>
  1018. <td>(</td>
  1019. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1020. <td class="paramname"><em>msg</em></td><td>)</td>
  1021. <td></td>
  1022. </tr>
  1023. </table>
  1024. </td>
  1025. <td class="mlabels-right">
  1026. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1027. </tr>
  1028. </table>
  1029. </div><div class="memdoc">
  1030. <p>Print msg, any SD error code.</p>
  1031. <dl class="params"><dt>Parameters</dt><dd>
  1032. <table class="params">
  1033. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1034. </table>
  1035. </dd>
  1036. </dl>
  1037. </div>
  1038. </div>
  1039. <a class="anchor" id="a43344a079d9af92ea4b550914d0512f6"></a>
  1040. <div class="memitem">
  1041. <div class="memproto">
  1042. <div class="memtemplate">
  1043. template&lt;class SdDriverClass&gt; </div>
  1044. <table class="mlabels">
  1045. <tr>
  1046. <td class="mlabels-left">
  1047. <table class="memname">
  1048. <tr>
  1049. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::errorPrint </td>
  1050. <td>(</td>
  1051. <td class="paramtype">Print *&#160;</td>
  1052. <td class="paramname"><em>pr</em>, </td>
  1053. </tr>
  1054. <tr>
  1055. <td class="paramkey"></td>
  1056. <td></td>
  1057. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1058. <td class="paramname"><em>msg</em>&#160;</td>
  1059. </tr>
  1060. <tr>
  1061. <td></td>
  1062. <td>)</td>
  1063. <td></td><td></td>
  1064. </tr>
  1065. </table>
  1066. </td>
  1067. <td class="mlabels-right">
  1068. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1069. </tr>
  1070. </table>
  1071. </div><div class="memdoc">
  1072. <p>Print msg, any SD error code.</p>
  1073. <dl class="params"><dt>Parameters</dt><dd>
  1074. <table class="params">
  1075. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1076. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1077. </table>
  1078. </dd>
  1079. </dl>
  1080. </div>
  1081. </div>
  1082. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></a>
  1083. <div class="memitem">
  1084. <div class="memproto">
  1085. <table class="mlabels">
  1086. <tr>
  1087. <td class="mlabels-left">
  1088. <table class="memname">
  1089. <tr>
  1090. <td class="memname">bool FatFileSystem::exists </td>
  1091. <td>(</td>
  1092. <td class="paramtype">const char *&#160;</td>
  1093. <td class="paramname"><em>path</em></td><td>)</td>
  1094. <td></td>
  1095. </tr>
  1096. </table>
  1097. </td>
  1098. <td class="mlabels-right">
  1099. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1100. </tr>
  1101. </table>
  1102. </div><div class="memdoc">
  1103. <p>Test for the existence of a file.</p>
  1104. <dl class="params"><dt>Parameters</dt><dd>
  1105. <table class="params">
  1106. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>
  1107. </table>
  1108. </dd>
  1109. </dl>
  1110. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>
  1111. </div>
  1112. </div>
  1113. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></a>
  1114. <div class="memitem">
  1115. <div class="memproto">
  1116. <table class="mlabels">
  1117. <tr>
  1118. <td class="mlabels-left">
  1119. <table class="memname">
  1120. <tr>
  1121. <td class="memname">uint8_t FatVolume::fatCount </td>
  1122. <td>(</td>
  1123. <td class="paramname"></td><td>)</td>
  1124. <td></td>
  1125. </tr>
  1126. </table>
  1127. </td>
  1128. <td class="mlabels-right">
  1129. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1130. </tr>
  1131. </table>
  1132. </div><div class="memdoc">
  1133. <dl class="section return"><dt>Returns</dt><dd>The number of <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> Allocation Tables. </dd></dl>
  1134. </div>
  1135. </div>
  1136. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></a>
  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">uint32_t FatVolume::fatStartBlock </td>
  1145. <td>(</td>
  1146. <td class="paramname"></td><td>)</td>
  1147. <td> const</td>
  1148. </tr>
  1149. </table>
  1150. </td>
  1151. <td class="mlabels-right">
  1152. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1153. </tr>
  1154. </table>
  1155. </div><div class="memdoc">
  1156. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  1157. </div>
  1158. </div>
  1159. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></a>
  1160. <div class="memitem">
  1161. <div class="memproto">
  1162. <table class="mlabels">
  1163. <tr>
  1164. <td class="mlabels-left">
  1165. <table class="memname">
  1166. <tr>
  1167. <td class="memname">uint8_t FatVolume::fatType </td>
  1168. <td>(</td>
  1169. <td class="paramname"></td><td>)</td>
  1170. <td> const</td>
  1171. </tr>
  1172. </table>
  1173. </td>
  1174. <td class="mlabels-right">
  1175. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1176. </tr>
  1177. </table>
  1178. </div><div class="memdoc">
  1179. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  1180. </div>
  1181. </div>
  1182. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></a>
  1183. <div class="memitem">
  1184. <div class="memproto">
  1185. <table class="mlabels">
  1186. <tr>
  1187. <td class="mlabels-left">
  1188. <table class="memname">
  1189. <tr>
  1190. <td class="memname">int32_t FatVolume::freeClusterCount </td>
  1191. <td>(</td>
  1192. <td class="paramname"></td><td>)</td>
  1193. <td></td>
  1194. </tr>
  1195. </table>
  1196. </td>
  1197. <td class="mlabels-right">
  1198. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1199. </tr>
  1200. </table>
  1201. </div><div class="memdoc">
  1202. <p>Volume free space in clusters.</p>
  1203. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  1204. </div>
  1205. </div>
  1206. <a class="anchor" id="acab819fa25a91dad1cc698a7e1e0eb32"></a>
  1207. <div class="memitem">
  1208. <div class="memproto">
  1209. <table class="mlabels">
  1210. <tr>
  1211. <td class="mlabels-left">
  1212. <table class="memname">
  1213. <tr>
  1214. <td class="memname">bool FatVolume::init </td>
  1215. <td>(</td>
  1216. <td class="paramname"></td><td>)</td>
  1217. <td></td>
  1218. </tr>
  1219. </table>
  1220. </td>
  1221. <td class="mlabels-right">
  1222. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1223. </tr>
  1224. </table>
  1225. </div><div class="memdoc">
  1226. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  1227. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1228. </div>
  1229. </div>
  1230. <a class="anchor" id="a034d997a1e7a0b2b664a4357bcccd256"></a>
  1231. <div class="memitem">
  1232. <div class="memproto">
  1233. <table class="mlabels">
  1234. <tr>
  1235. <td class="mlabels-left">
  1236. <table class="memname">
  1237. <tr>
  1238. <td class="memname">bool FatVolume::init </td>
  1239. <td>(</td>
  1240. <td class="paramtype">uint8_t&#160;</td>
  1241. <td class="paramname"><em>part</em></td><td>)</td>
  1242. <td></td>
  1243. </tr>
  1244. </table>
  1245. </td>
  1246. <td class="mlabels-right">
  1247. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  1248. </tr>
  1249. </table>
  1250. </div><div class="memdoc">
  1251. <p>Initialize a FAT volume.</p>
  1252. <dl class="params"><dt>Parameters</dt><dd>
  1253. <table class="params">
  1254. <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>The partition to be used. Legal values for <em>part</em> are 1-4 to use the corresponding partition on a device formatted with a MBR, Master Boot Record, or zero if the device is formatted as a super floppy with the FAT boot sector in block zero.</td></tr>
  1255. </table>
  1256. </dd>
  1257. </dl>
  1258. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1259. </div>
  1260. </div>
  1261. <a class="anchor" id="a8e1f26486bb878a24fa9868e59dbbbc2"></a>
  1262. <div class="memitem">
  1263. <div class="memproto">
  1264. <div class="memtemplate">
  1265. template&lt;class SdDriverClass&gt; </div>
  1266. <table class="mlabels">
  1267. <tr>
  1268. <td class="mlabels-left">
  1269. <table class="memname">
  1270. <tr>
  1271. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>
  1272. <td>(</td>
  1273. <td class="paramname"></td><td>)</td>
  1274. <td></td>
  1275. </tr>
  1276. </table>
  1277. </td>
  1278. <td class="mlabels-right">
  1279. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1280. </tr>
  1281. </table>
  1282. </div><div class="memdoc">
  1283. <p>Print any SD error code and halt. </p>
  1284. </div>
  1285. </div>
  1286. <a class="anchor" id="a24bd0f699cf0fe11fd2148b15c49251a"></a>
  1287. <div class="memitem">
  1288. <div class="memproto">
  1289. <div class="memtemplate">
  1290. template&lt;class SdDriverClass&gt; </div>
  1291. <table class="mlabels">
  1292. <tr>
  1293. <td class="mlabels-left">
  1294. <table class="memname">
  1295. <tr>
  1296. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>
  1297. <td>(</td>
  1298. <td class="paramtype">Print *&#160;</td>
  1299. <td class="paramname"><em>pr</em></td><td>)</td>
  1300. <td></td>
  1301. </tr>
  1302. </table>
  1303. </td>
  1304. <td class="mlabels-right">
  1305. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1306. </tr>
  1307. </table>
  1308. </div><div class="memdoc">
  1309. <p>Print error details and halt after begin fails.</p>
  1310. <dl class="params"><dt>Parameters</dt><dd>
  1311. <table class="params">
  1312. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1313. </table>
  1314. </dd>
  1315. </dl>
  1316. </div>
  1317. </div>
  1318. <a class="anchor" id="a893833a880e2a83757480ba4c1351041"></a>
  1319. <div class="memitem">
  1320. <div class="memproto">
  1321. <div class="memtemplate">
  1322. template&lt;class SdDriverClass&gt; </div>
  1323. <table class="mlabels">
  1324. <tr>
  1325. <td class="mlabels-left">
  1326. <table class="memname">
  1327. <tr>
  1328. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>
  1329. <td>(</td>
  1330. <td class="paramtype">char const *&#160;</td>
  1331. <td class="paramname"><em>msg</em></td><td>)</td>
  1332. <td></td>
  1333. </tr>
  1334. </table>
  1335. </td>
  1336. <td class="mlabels-right">
  1337. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1338. </tr>
  1339. </table>
  1340. </div><div class="memdoc">
  1341. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1342. <dl class="params"><dt>Parameters</dt><dd>
  1343. <table class="params">
  1344. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1345. </table>
  1346. </dd>
  1347. </dl>
  1348. </div>
  1349. </div>
  1350. <a class="anchor" id="a3077b1a53d789d0401b707963cb28f46"></a>
  1351. <div class="memitem">
  1352. <div class="memproto">
  1353. <div class="memtemplate">
  1354. template&lt;class SdDriverClass&gt; </div>
  1355. <table class="mlabels">
  1356. <tr>
  1357. <td class="mlabels-left">
  1358. <table class="memname">
  1359. <tr>
  1360. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>
  1361. <td>(</td>
  1362. <td class="paramtype">Print *&#160;</td>
  1363. <td class="paramname"><em>pr</em>, </td>
  1364. </tr>
  1365. <tr>
  1366. <td class="paramkey"></td>
  1367. <td></td>
  1368. <td class="paramtype">char const *&#160;</td>
  1369. <td class="paramname"><em>msg</em>&#160;</td>
  1370. </tr>
  1371. <tr>
  1372. <td></td>
  1373. <td>)</td>
  1374. <td></td><td></td>
  1375. </tr>
  1376. </table>
  1377. </td>
  1378. <td class="mlabels-right">
  1379. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1380. </tr>
  1381. </table>
  1382. </div><div class="memdoc">
  1383. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  1384. <table class="params">
  1385. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>
  1386. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1387. </table>
  1388. </dd>
  1389. </dl>
  1390. </div>
  1391. </div>
  1392. <a class="anchor" id="a2a1e4cc8056ba23b55dfa2c6486b8798"></a>
  1393. <div class="memitem">
  1394. <div class="memproto">
  1395. <div class="memtemplate">
  1396. template&lt;class SdDriverClass&gt; </div>
  1397. <table class="mlabels">
  1398. <tr>
  1399. <td class="mlabels-left">
  1400. <table class="memname">
  1401. <tr>
  1402. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>
  1403. <td>(</td>
  1404. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1405. <td class="paramname"><em>msg</em></td><td>)</td>
  1406. <td></td>
  1407. </tr>
  1408. </table>
  1409. </td>
  1410. <td class="mlabels-right">
  1411. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1412. </tr>
  1413. </table>
  1414. </div><div class="memdoc">
  1415. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1416. <dl class="params"><dt>Parameters</dt><dd>
  1417. <table class="params">
  1418. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1419. </table>
  1420. </dd>
  1421. </dl>
  1422. </div>
  1423. </div>
  1424. <a class="anchor" id="ab03d98012dea18733c3252f27832de69"></a>
  1425. <div class="memitem">
  1426. <div class="memproto">
  1427. <div class="memtemplate">
  1428. template&lt;class SdDriverClass&gt; </div>
  1429. <table class="mlabels">
  1430. <tr>
  1431. <td class="mlabels-left">
  1432. <table class="memname">
  1433. <tr>
  1434. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorHalt </td>
  1435. <td>(</td>
  1436. <td class="paramtype">Print *&#160;</td>
  1437. <td class="paramname"><em>pr</em>, </td>
  1438. </tr>
  1439. <tr>
  1440. <td class="paramkey"></td>
  1441. <td></td>
  1442. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1443. <td class="paramname"><em>msg</em>&#160;</td>
  1444. </tr>
  1445. <tr>
  1446. <td></td>
  1447. <td>)</td>
  1448. <td></td><td></td>
  1449. </tr>
  1450. </table>
  1451. </td>
  1452. <td class="mlabels-right">
  1453. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1454. </tr>
  1455. </table>
  1456. </div><div class="memdoc">
  1457. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>
  1458. <table class="params">
  1459. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device for message. </td></tr>
  1460. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1461. </table>
  1462. </dd>
  1463. </dl>
  1464. </div>
  1465. </div>
  1466. <a class="anchor" id="ae31c9cbd7e1c03129d6c99b25f73cd50"></a>
  1467. <div class="memitem">
  1468. <div class="memproto">
  1469. <div class="memtemplate">
  1470. template&lt;class SdDriverClass&gt; </div>
  1471. <table class="mlabels">
  1472. <tr>
  1473. <td class="mlabels-left">
  1474. <table class="memname">
  1475. <tr>
  1476. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>
  1477. <td>(</td>
  1478. <td class="paramname"></td><td>)</td>
  1479. <td></td>
  1480. </tr>
  1481. </table>
  1482. </td>
  1483. <td class="mlabels-right">
  1484. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1485. </tr>
  1486. </table>
  1487. </div><div class="memdoc">
  1488. <p>Print error details after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p>
  1489. </div>
  1490. </div>
  1491. <a class="anchor" id="a066707dce0667213b5f083d59f67448d"></a>
  1492. <div class="memitem">
  1493. <div class="memproto">
  1494. <div class="memtemplate">
  1495. template&lt;class SdDriverClass&gt; </div>
  1496. <table class="mlabels">
  1497. <tr>
  1498. <td class="mlabels-left">
  1499. <table class="memname">
  1500. <tr>
  1501. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>
  1502. <td>(</td>
  1503. <td class="paramtype">Print *&#160;</td>
  1504. <td class="paramname"><em>pr</em></td><td>)</td>
  1505. <td></td>
  1506. </tr>
  1507. </table>
  1508. </td>
  1509. <td class="mlabels-right">
  1510. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1511. </tr>
  1512. </table>
  1513. </div><div class="memdoc">
  1514. <p>Print error details after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1515. <dl class="params"><dt>Parameters</dt><dd>
  1516. <table class="params">
  1517. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1518. </table>
  1519. </dd>
  1520. </dl>
  1521. </div>
  1522. </div>
  1523. <a class="anchor" id="a538796f79fd9db9c5bbeefd9defe639a"></a>
  1524. <div class="memitem">
  1525. <div class="memproto">
  1526. <div class="memtemplate">
  1527. template&lt;class SdDriverClass&gt; </div>
  1528. <table class="mlabels">
  1529. <tr>
  1530. <td class="mlabels-left">
  1531. <table class="memname">
  1532. <tr>
  1533. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>
  1534. <td>(</td>
  1535. <td class="paramtype">char const *&#160;</td>
  1536. <td class="paramname"><em>msg</em></td><td>)</td>
  1537. <td></td>
  1538. </tr>
  1539. </table>
  1540. </td>
  1541. <td class="mlabels-right">
  1542. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1543. </tr>
  1544. </table>
  1545. </div><div class="memdoc">
  1546. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1547. <dl class="params"><dt>Parameters</dt><dd>
  1548. <table class="params">
  1549. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1550. </table>
  1551. </dd>
  1552. </dl>
  1553. </div>
  1554. </div>
  1555. <a class="anchor" id="ad9855d33ebd465715b706d0926291b13"></a>
  1556. <div class="memitem">
  1557. <div class="memproto">
  1558. <div class="memtemplate">
  1559. template&lt;class SdDriverClass&gt; </div>
  1560. <table class="mlabels">
  1561. <tr>
  1562. <td class="mlabels-left">
  1563. <table class="memname">
  1564. <tr>
  1565. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>
  1566. <td>(</td>
  1567. <td class="paramtype">Print *&#160;</td>
  1568. <td class="paramname"><em>pr</em>, </td>
  1569. </tr>
  1570. <tr>
  1571. <td class="paramkey"></td>
  1572. <td></td>
  1573. <td class="paramtype">char const *&#160;</td>
  1574. <td class="paramname"><em>msg</em>&#160;</td>
  1575. </tr>
  1576. <tr>
  1577. <td></td>
  1578. <td>)</td>
  1579. <td></td><td></td>
  1580. </tr>
  1581. </table>
  1582. </td>
  1583. <td class="mlabels-right">
  1584. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1585. </tr>
  1586. </table>
  1587. </div><div class="memdoc">
  1588. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1589. <dl class="params"><dt>Parameters</dt><dd>
  1590. <table class="params">
  1591. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1592. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1593. </table>
  1594. </dd>
  1595. </dl>
  1596. </div>
  1597. </div>
  1598. <a class="anchor" id="ad6ffec5a7d82be46d46b8a4f82d0803b"></a>
  1599. <div class="memitem">
  1600. <div class="memproto">
  1601. <div class="memtemplate">
  1602. template&lt;class SdDriverClass&gt; </div>
  1603. <table class="mlabels">
  1604. <tr>
  1605. <td class="mlabels-left">
  1606. <table class="memname">
  1607. <tr>
  1608. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>
  1609. <td>(</td>
  1610. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1611. <td class="paramname"><em>msg</em></td><td>)</td>
  1612. <td></td>
  1613. </tr>
  1614. </table>
  1615. </td>
  1616. <td class="mlabels-right">
  1617. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1618. </tr>
  1619. </table>
  1620. </div><div class="memdoc">
  1621. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1622. <dl class="params"><dt>Parameters</dt><dd>
  1623. <table class="params">
  1624. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1625. </table>
  1626. </dd>
  1627. </dl>
  1628. </div>
  1629. </div>
  1630. <a class="anchor" id="a8a2018b6366145a9843d3d29a47d6560"></a>
  1631. <div class="memitem">
  1632. <div class="memproto">
  1633. <div class="memtemplate">
  1634. template&lt;class SdDriverClass&gt; </div>
  1635. <table class="mlabels">
  1636. <tr>
  1637. <td class="mlabels-left">
  1638. <table class="memname">
  1639. <tr>
  1640. <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; SdDriverClass &gt;::initErrorPrint </td>
  1641. <td>(</td>
  1642. <td class="paramtype">Print *&#160;</td>
  1643. <td class="paramname"><em>pr</em>, </td>
  1644. </tr>
  1645. <tr>
  1646. <td class="paramkey"></td>
  1647. <td></td>
  1648. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  1649. <td class="paramname"><em>msg</em>&#160;</td>
  1650. </tr>
  1651. <tr>
  1652. <td></td>
  1653. <td>)</td>
  1654. <td></td><td></td>
  1655. </tr>
  1656. </table>
  1657. </td>
  1658. <td class="mlabels-right">
  1659. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  1660. </tr>
  1661. </table>
  1662. </div><div class="memdoc">
  1663. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>
  1664. <dl class="params"><dt>Parameters</dt><dd>
  1665. <table class="params">
  1666. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>
  1667. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>
  1668. </table>
  1669. </dd>
  1670. </dl>
  1671. </div>
  1672. </div>
  1673. <a class="anchor" id="a2398fb37a7a9d5e0dc0ffde6a44a993d"></a>
  1674. <div class="memitem">
  1675. <div class="memproto">
  1676. <table class="mlabels">
  1677. <tr>
  1678. <td class="mlabels-left">
  1679. <table class="memname">
  1680. <tr>
  1681. <td class="memname">void FatFileSystem::ls </td>
  1682. <td>(</td>
  1683. <td class="paramtype">uint8_t&#160;</td>
  1684. <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
  1685. <td></td>
  1686. </tr>
  1687. </table>
  1688. </td>
  1689. <td class="mlabels-right">
  1690. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1691. </tr>
  1692. </table>
  1693. </div><div class="memdoc">
  1694. <p>List the directory contents of the volume working directory to Serial.</p>
  1695. <dl class="params"><dt>Parameters</dt><dd>
  1696. <table class="params">
  1697. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1698. </table>
  1699. </dd>
  1700. </dl>
  1701. <p>LS_DATE - Print file modification date</p>
  1702. <p>LS_SIZE - Print file size.</p>
  1703. <p>LS_R - Recursive list of subdirectories. </p>
  1704. </div>
  1705. </div>
  1706. <a class="anchor" id="a122b61dbec5051304bcc81bc08b1b99d"></a>
  1707. <div class="memitem">
  1708. <div class="memproto">
  1709. <table class="mlabels">
  1710. <tr>
  1711. <td class="mlabels-left">
  1712. <table class="memname">
  1713. <tr>
  1714. <td class="memname">void FatFileSystem::ls </td>
  1715. <td>(</td>
  1716. <td class="paramtype">const char *&#160;</td>
  1717. <td class="paramname"><em>path</em>, </td>
  1718. </tr>
  1719. <tr>
  1720. <td class="paramkey"></td>
  1721. <td></td>
  1722. <td class="paramtype">uint8_t&#160;</td>
  1723. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1724. </tr>
  1725. <tr>
  1726. <td></td>
  1727. <td>)</td>
  1728. <td></td><td></td>
  1729. </tr>
  1730. </table>
  1731. </td>
  1732. <td class="mlabels-right">
  1733. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1734. </tr>
  1735. </table>
  1736. </div><div class="memdoc">
  1737. <p>List the directory contents of a directory to Serial.</p>
  1738. <dl class="params"><dt>Parameters</dt><dd>
  1739. <table class="params">
  1740. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1741. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1742. </table>
  1743. </dd>
  1744. </dl>
  1745. <p>LS_DATE - Print file modification date</p>
  1746. <p>LS_SIZE - Print file size.</p>
  1747. <p>LS_R - Recursive list of subdirectories. </p>
  1748. </div>
  1749. </div>
  1750. <a class="anchor" id="ae12fb8bfad5c4a8e052dda70a5a0ed93"></a>
  1751. <div class="memitem">
  1752. <div class="memproto">
  1753. <table class="mlabels">
  1754. <tr>
  1755. <td class="mlabels-left">
  1756. <table class="memname">
  1757. <tr>
  1758. <td class="memname">void FatFileSystem::ls </td>
  1759. <td>(</td>
  1760. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1761. <td class="paramname"><em>pr</em>, </td>
  1762. </tr>
  1763. <tr>
  1764. <td class="paramkey"></td>
  1765. <td></td>
  1766. <td class="paramtype">uint8_t&#160;</td>
  1767. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  1768. </tr>
  1769. <tr>
  1770. <td></td>
  1771. <td>)</td>
  1772. <td></td><td></td>
  1773. </tr>
  1774. </table>
  1775. </td>
  1776. <td class="mlabels-right">
  1777. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1778. </tr>
  1779. </table>
  1780. </div><div class="memdoc">
  1781. <p>List the directory contents of the volume working directory.</p>
  1782. <dl class="params"><dt>Parameters</dt><dd>
  1783. <table class="params">
  1784. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1785. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1786. </table>
  1787. </dd>
  1788. </dl>
  1789. <p>LS_DATE - Print file modification date</p>
  1790. <p>LS_SIZE - Print file size.</p>
  1791. <p>LS_R - Recursive list of subdirectories. </p>
  1792. </div>
  1793. </div>
  1794. <a class="anchor" id="aa79695db8e910300507210b3067d39fd"></a>
  1795. <div class="memitem">
  1796. <div class="memproto">
  1797. <table class="mlabels">
  1798. <tr>
  1799. <td class="mlabels-left">
  1800. <table class="memname">
  1801. <tr>
  1802. <td class="memname">void FatFileSystem::ls </td>
  1803. <td>(</td>
  1804. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  1805. <td class="paramname"><em>pr</em>, </td>
  1806. </tr>
  1807. <tr>
  1808. <td class="paramkey"></td>
  1809. <td></td>
  1810. <td class="paramtype">const char *&#160;</td>
  1811. <td class="paramname"><em>path</em>, </td>
  1812. </tr>
  1813. <tr>
  1814. <td class="paramkey"></td>
  1815. <td></td>
  1816. <td class="paramtype">uint8_t&#160;</td>
  1817. <td class="paramname"><em>flags</em>&#160;</td>
  1818. </tr>
  1819. <tr>
  1820. <td></td>
  1821. <td>)</td>
  1822. <td></td><td></td>
  1823. </tr>
  1824. </table>
  1825. </td>
  1826. <td class="mlabels-right">
  1827. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1828. </tr>
  1829. </table>
  1830. </div><div class="memdoc">
  1831. <p>List the directory contents of a directory.</p>
  1832. <dl class="params"><dt>Parameters</dt><dd>
  1833. <table class="params">
  1834. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>
  1835. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>
  1836. <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>
  1837. </table>
  1838. </dd>
  1839. </dl>
  1840. <p>LS_DATE - Print file modification date</p>
  1841. <p>LS_SIZE - Print file size.</p>
  1842. <p>LS_R - Recursive list of subdirectories. </p>
  1843. </div>
  1844. </div>
  1845. <a class="anchor" id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>
  1846. <div class="memitem">
  1847. <div class="memproto">
  1848. <table class="mlabels">
  1849. <tr>
  1850. <td class="mlabels-left">
  1851. <table class="memname">
  1852. <tr>
  1853. <td class="memname">bool FatFileSystem::mkdir </td>
  1854. <td>(</td>
  1855. <td class="paramtype">const char *&#160;</td>
  1856. <td class="paramname"><em>path</em>, </td>
  1857. </tr>
  1858. <tr>
  1859. <td class="paramkey"></td>
  1860. <td></td>
  1861. <td class="paramtype">bool&#160;</td>
  1862. <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>
  1863. </tr>
  1864. <tr>
  1865. <td></td>
  1866. <td>)</td>
  1867. <td></td><td></td>
  1868. </tr>
  1869. </table>
  1870. </td>
  1871. <td class="mlabels-right">
  1872. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1873. </tr>
  1874. </table>
  1875. </div><div class="memdoc">
  1876. <p>Make a subdirectory in the volume working directory.</p>
  1877. <dl class="params"><dt>Parameters</dt><dd>
  1878. <table class="params">
  1879. <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>
  1880. <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>
  1881. </table>
  1882. </dd>
  1883. </dl>
  1884. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  1885. </div>
  1886. </div>
  1887. <a class="anchor" id="a947e4586077a922892b632edac33b67a"></a>
  1888. <div class="memitem">
  1889. <div class="memproto">
  1890. <table class="mlabels">
  1891. <tr>
  1892. <td class="mlabels-left">
  1893. <table class="memname">
  1894. <tr>
  1895. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  1896. <td>(</td>
  1897. <td class="paramtype">const char *&#160;</td>
  1898. <td class="paramname"><em>path</em>, </td>
  1899. </tr>
  1900. <tr>
  1901. <td class="paramkey"></td>
  1902. <td></td>
  1903. <td class="paramtype">uint8_t&#160;</td>
  1904. <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  1905. </tr>
  1906. <tr>
  1907. <td></td>
  1908. <td>)</td>
  1909. <td></td><td></td>
  1910. </tr>
  1911. </table>
  1912. </td>
  1913. <td class="mlabels-right">
  1914. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1915. </tr>
  1916. </table>
  1917. </div><div class="memdoc">
  1918. <p>open a file</p>
  1919. <dl class="params"><dt>Parameters</dt><dd>
  1920. <table class="params">
  1921. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1922. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  1923. </table>
  1924. </dd>
  1925. </dl>
  1926. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  1927. </div>
  1928. </div>
  1929. <a class="anchor" id="a0abfb1f754a8fb559cfa884ee040f56f"></a>
  1930. <div class="memitem">
  1931. <div class="memproto">
  1932. <table class="mlabels">
  1933. <tr>
  1934. <td class="mlabels-left">
  1935. <table class="memname">
  1936. <tr>
  1937. <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>
  1938. <td>(</td>
  1939. <td class="paramtype">const String &amp;&#160;</td>
  1940. <td class="paramname"><em>path</em>, </td>
  1941. </tr>
  1942. <tr>
  1943. <td class="paramkey"></td>
  1944. <td></td>
  1945. <td class="paramtype">uint8_t&#160;</td>
  1946. <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>
  1947. </tr>
  1948. <tr>
  1949. <td></td>
  1950. <td>)</td>
  1951. <td></td><td></td>
  1952. </tr>
  1953. </table>
  1954. </td>
  1955. <td class="mlabels-right">
  1956. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1957. </tr>
  1958. </table>
  1959. </div><div class="memdoc">
  1960. <p>open a file</p>
  1961. <dl class="params"><dt>Parameters</dt><dd>
  1962. <table class="params">
  1963. <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>
  1964. <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>
  1965. </table>
  1966. </dd>
  1967. </dl>
  1968. <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> object. </dd></dl>
  1969. </div>
  1970. </div>
  1971. <a class="anchor" id="abf7d7d0dab43083d5be10d70ff4669e4"></a>
  1972. <div class="memitem">
  1973. <div class="memproto">
  1974. <table class="mlabels">
  1975. <tr>
  1976. <td class="mlabels-left">
  1977. <table class="memname">
  1978. <tr>
  1979. <td class="memname">bool FatFileSystem::remove </td>
  1980. <td>(</td>
  1981. <td class="paramtype">const char *&#160;</td>
  1982. <td class="paramname"><em>path</em></td><td>)</td>
  1983. <td></td>
  1984. </tr>
  1985. </table>
  1986. </td>
  1987. <td class="mlabels-right">
  1988. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  1989. </tr>
  1990. </table>
  1991. </div><div class="memdoc">
  1992. <p>Remove a file from the volume working directory.</p>
  1993. <dl class="params"><dt>Parameters</dt><dd>
  1994. <table class="params">
  1995. <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>
  1996. </table>
  1997. </dd>
  1998. </dl>
  1999. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2000. </div>
  2001. </div>
  2002. <a class="anchor" id="a0187891a24017b41bd7c5ba63e659e65"></a>
  2003. <div class="memitem">
  2004. <div class="memproto">
  2005. <table class="mlabels">
  2006. <tr>
  2007. <td class="mlabels-left">
  2008. <table class="memname">
  2009. <tr>
  2010. <td class="memname">bool FatFileSystem::rename </td>
  2011. <td>(</td>
  2012. <td class="paramtype">const char *&#160;</td>
  2013. <td class="paramname"><em>oldPath</em>, </td>
  2014. </tr>
  2015. <tr>
  2016. <td class="paramkey"></td>
  2017. <td></td>
  2018. <td class="paramtype">const char *&#160;</td>
  2019. <td class="paramname"><em>newPath</em>&#160;</td>
  2020. </tr>
  2021. <tr>
  2022. <td></td>
  2023. <td>)</td>
  2024. <td></td><td></td>
  2025. </tr>
  2026. </table>
  2027. </td>
  2028. <td class="mlabels-right">
  2029. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2030. </tr>
  2031. </table>
  2032. </div><div class="memdoc">
  2033. <p>Rename a file or subdirectory.</p>
  2034. <dl class="params"><dt>Parameters</dt><dd>
  2035. <table class="params">
  2036. <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>
  2037. <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>
  2038. </table>
  2039. </dd>
  2040. </dl>
  2041. <p>The <em>newPath</em> object must not exist before the rename call.</p>
  2042. <p>The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the <a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename()</a> call.</p>
  2043. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2044. </div>
  2045. </div>
  2046. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>
  2047. <div class="memitem">
  2048. <div class="memproto">
  2049. <table class="mlabels">
  2050. <tr>
  2051. <td class="mlabels-left">
  2052. <table class="memname">
  2053. <tr>
  2054. <td class="memname">bool FatFileSystem::rmdir </td>
  2055. <td>(</td>
  2056. <td class="paramtype">const char *&#160;</td>
  2057. <td class="paramname"><em>path</em></td><td>)</td>
  2058. <td></td>
  2059. </tr>
  2060. </table>
  2061. </td>
  2062. <td class="mlabels-right">
  2063. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2064. </tr>
  2065. </table>
  2066. </div><div class="memdoc">
  2067. <p>Remove a subdirectory from the volume's working directory.</p>
  2068. <dl class="params"><dt>Parameters</dt><dd>
  2069. <table class="params">
  2070. <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>
  2071. </table>
  2072. </dd>
  2073. </dl>
  2074. <p>The subdirectory file will be removed only if it is empty.</p>
  2075. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2076. </div>
  2077. </div>
  2078. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>
  2079. <div class="memitem">
  2080. <div class="memproto">
  2081. <table class="mlabels">
  2082. <tr>
  2083. <td class="mlabels-left">
  2084. <table class="memname">
  2085. <tr>
  2086. <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>
  2087. <td>(</td>
  2088. <td class="paramname"></td><td>)</td>
  2089. <td> const</td>
  2090. </tr>
  2091. </table>
  2092. </td>
  2093. <td class="mlabels-right">
  2094. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2095. </tr>
  2096. </table>
  2097. </div><div class="memdoc">
  2098. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  2099. </div>
  2100. </div>
  2101. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>
  2102. <div class="memitem">
  2103. <div class="memproto">
  2104. <table class="mlabels">
  2105. <tr>
  2106. <td class="mlabels-left">
  2107. <table class="memname">
  2108. <tr>
  2109. <td class="memname">uint32_t FatVolume::rootDirStart </td>
  2110. <td>(</td>
  2111. <td class="paramname"></td><td>)</td>
  2112. <td> const</td>
  2113. </tr>
  2114. </table>
  2115. </td>
  2116. <td class="mlabels-right">
  2117. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2118. </tr>
  2119. </table>
  2120. </div><div class="memdoc">
  2121. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>
  2122. </div>
  2123. </div>
  2124. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>
  2125. <div class="memitem">
  2126. <div class="memproto">
  2127. <table class="mlabels">
  2128. <tr>
  2129. <td class="mlabels-left">
  2130. <table class="memname">
  2131. <tr>
  2132. <td class="memname">bool FatFileSystem::truncate </td>
  2133. <td>(</td>
  2134. <td class="paramtype">const char *&#160;</td>
  2135. <td class="paramname"><em>path</em>, </td>
  2136. </tr>
  2137. <tr>
  2138. <td class="paramkey"></td>
  2139. <td></td>
  2140. <td class="paramtype">uint32_t&#160;</td>
  2141. <td class="paramname"><em>length</em>&#160;</td>
  2142. </tr>
  2143. <tr>
  2144. <td></td>
  2145. <td>)</td>
  2146. <td></td><td></td>
  2147. </tr>
  2148. </table>
  2149. </td>
  2150. <td class="mlabels-right">
  2151. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2152. </tr>
  2153. </table>
  2154. </div><div class="memdoc">
  2155. <p>Truncate a file to a specified length. The current file position will be maintained if it is less than or equal to <em>length</em> otherwise it will be set to end of file.</p>
  2156. <dl class="params"><dt>Parameters</dt><dd>
  2157. <table class="params">
  2158. <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>
  2159. <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>
  2160. </table>
  2161. </dd>
  2162. </dl>
  2163. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  2164. </div>
  2165. </div>
  2166. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>
  2167. <div class="memitem">
  2168. <div class="memproto">
  2169. <table class="mlabels">
  2170. <tr>
  2171. <td class="mlabels-left">
  2172. <table class="memname">
  2173. <tr>
  2174. <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>
  2175. <td>(</td>
  2176. <td class="paramname"></td><td>)</td>
  2177. <td></td>
  2178. </tr>
  2179. </table>
  2180. </td>
  2181. <td class="mlabels-right">
  2182. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2183. </tr>
  2184. </table>
  2185. </div><div class="memdoc">
  2186. <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> object. </dd></dl>
  2187. </div>
  2188. </div>
  2189. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>
  2190. <div class="memitem">
  2191. <div class="memproto">
  2192. <table class="mlabels">
  2193. <tr>
  2194. <td class="mlabels-left">
  2195. <table class="memname">
  2196. <tr>
  2197. <td class="memname">uint32_t FatVolume::volumeBlockCount </td>
  2198. <td>(</td>
  2199. <td class="paramname"></td><td>)</td>
  2200. <td> const</td>
  2201. </tr>
  2202. </table>
  2203. </td>
  2204. <td class="mlabels-right">
  2205. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2206. </tr>
  2207. </table>
  2208. </div><div class="memdoc">
  2209. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>
  2210. </div>
  2211. </div>
  2212. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>
  2213. <div class="memitem">
  2214. <div class="memproto">
  2215. <table class="mlabels">
  2216. <tr>
  2217. <td class="mlabels-left">
  2218. <table class="memname">
  2219. <tr>
  2220. <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>
  2221. <td>(</td>
  2222. <td class="paramname"></td><td>)</td>
  2223. <td></td>
  2224. </tr>
  2225. </table>
  2226. </td>
  2227. <td class="mlabels-right">
  2228. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2229. </tr>
  2230. </table>
  2231. </div><div class="memdoc">
  2232. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>
  2233. </div>
  2234. </div>
  2235. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>
  2236. <div class="memitem">
  2237. <div class="memproto">
  2238. <table class="mlabels">
  2239. <tr>
  2240. <td class="mlabels-left">
  2241. <table class="memname">
  2242. <tr>
  2243. <td class="memname">bool FatFileSystem::wipe </td>
  2244. <td>(</td>
  2245. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  2246. <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>
  2247. <td></td>
  2248. </tr>
  2249. </table>
  2250. </td>
  2251. <td class="mlabels-right">
  2252. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  2253. </tr>
  2254. </table>
  2255. </div><div class="memdoc">
  2256. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>
  2257. <table class="params">
  2258. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>
  2259. </table>
  2260. </dd>
  2261. </dl>
  2262. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  2263. </div>
  2264. </div>
  2265. <hr/>The documentation for this class was generated from the following file:<ul>
  2266. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>
  2267. </ul>
  2268. </div><!-- contents -->
  2269. <!-- start footer part -->
  2270. <hr class="footer"/><address class="footer"><small>
  2271. Generated on Mon Sep 5 2016 10:18:53 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  2272. <img class="footer" src="doxygen.png" alt="doxygen"/>
  2273. </a> 1.8.10
  2274. </small></address>
  2275. </body>
  2276. </html>