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

2513 line
108KB

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