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.

2314 line
98KB

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