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.

2366 lines
102KB

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