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

2437 lines
105KB

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