visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
31 Commits
1 Branch
Tree: 080e24c4d1
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '080e24c4d1'
${ noResults }
teensy-sdfat/html/class_sd_fat_base.html

2138 lines
90KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.10"/>

  7. <title>SdFat: SdFatBase Class Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/searchdata.js"></script>

  13. <script type="text/javascript" src="search/search.js"></script>

  14. <script type="text/javascript">

  15.   $(document).ready(function() { init_search(); });

  16. </script>

  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  18. </head>

  19. <body>

  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  21. <div id="titlearea">

  22. <table cellspacing="0" cellpadding="0">

  23.  <tbody>

  24.  <tr style="height: 56px;">

  25.   <td id="projectalign" style="padding-left: 0.5em;">

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

  33. <!-- end header part -->

  34. <!-- Generated by Doxygen 1.8.10 -->

  35. <script type="text/javascript">

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  37. </script>

  38.   <div id="navrow1" class="tabs">

  39.     <ul class="tablist">

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  41.       <li><a href="modules.html"><span>Modules</span></a></li>

  42.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  43.       <li><a href="files.html"><span>Files</span></a></li>

  44.       <li>

  45.         <div id="MSearchBox" class="MSearchBoxInactive">

  46.         <span class="left">

  47.           <img id="MSearchSelect" src="search/mag_sel.png"

  48.                onmouseover="return searchBox.OnSearchSelectShow()"

  49.                onmouseout="return searchBox.OnSearchSelectHide()"

  50.                alt=""/>

  51.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  52.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  53.                onblur="searchBox.OnSearchFieldFocus(false)" 

  54.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  55.           </span><span class="right">

  56.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

  62.   <div id="navrow2" class="tabs2">

  63.     <ul class="tablist">

  64.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  65.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. </div>

  75. 

  76. <!-- iframe showing the search results (closed by default) -->

  77. <div id="MSearchResultsWindow">

  78. <iframe src="javascript:void(0)" frameborder="0" 

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

  83. </div><!-- top -->

  84. <div class="header">

  85.   <div class="summary">

  86. <a href="#pub-methods">Public Member Functions</a> &#124;

  87. <a href="class_sd_fat_base-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

  89. <div class="title">SdFatBase Class Reference</div>  </div>

  90. </div><!--header-->

  91. <div class="contents">

  92. 

  93. <p>Virtual base class for SdFat library.  

  94.  <a href="class_sd_fat_base.html#details">More...</a></p>

  95. 

  96. <p><code>#include &lt;SdFat.h&gt;</code></p>

  97. <div class="dynheader">

  98. Inheritance diagram for SdFatBase:</div>

  99. <div class="dyncontent">

  100. <div class="center"><img src="class_sd_fat_base__inherit__graph.png" border="0" usemap="#_sd_fat_base_inherit__map" alt="Inheritance graph"/></div>

  101. <map name="_sd_fat_base_inherit__map" id="_sd_fat_base_inherit__map">

  102. <area shape="rect" id="node4" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="5,237,63,263"/>

  103. <area shape="rect" id="node5" href="class_sd_fat_lib_spi.html" title="SdFat class using the standard Arduino SPI library. " alt="" coords="87,237,181,263"/>

  104. <area shape="rect" id="node6" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="205,229,367,271"/>

  105. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="81,80,187,107"/>

  106. <area shape="rect" id="node3" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="91,5,177,32"/>

  107. </map>

  108. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  109. <div class="dynheader">

  110. Collaboration diagram for SdFatBase:</div>

  111. <div class="dyncontent">

  112. <div class="center"><img src="class_sd_fat_base__coll__graph.png" border="0" usemap="#_sd_fat_base_coll__map" alt="Collaboration graph"/></div>

  113. <map name="_sd_fat_base_coll__map" id="_sd_fat_base_coll__map">

  114. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="5,80,112,107"/>

  115. <area shape="rect" id="node3" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="16,5,101,32"/>

  116. </map>

  117. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  118. <table class="memberdecls">

  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  120. Public Member Functions</h2></td></tr>

  121. <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>

  122. <tr class="separator:a05bd3d358a708efe2f9002d05c3a4139"><td class="memSeparator" colspan="2">&#160;</td></tr>

  123. <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>

  124. <tr class="separator:a3d3f2cc4df1b6f2a129c3a614c1e5e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  125. <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>

  126. <tr class="separator:a06beed4cea5e38116b58254a57125442"><td class="memSeparator" colspan="2">&#160;</td></tr>

  127. <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>

  128. <tr class="separator:abc66d856d05198d9ebe7104c8c4155d7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  129. <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>

  130. <tr class="separator:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  131. <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>

  132. <tr class="separator:a899294ced4e4585feae7668099338534"><td class="memSeparator" colspan="2">&#160;</td></tr>

  133. <tr class="memitem:a5667915e63187a43a71dfada63800865"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5667915e63187a43a71dfada63800865">chdir</a> (bool set_cwd=false)</td></tr>

  134. <tr class="separator:a5667915e63187a43a71dfada63800865"><td class="memSeparator" colspan="2">&#160;</td></tr>

  135. <tr class="memitem:a44af1b98e8d986d12107b654453acbc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a44af1b98e8d986d12107b654453acbc4">chdir</a> (const char *path, bool set_cwd=false)</td></tr>

  136. <tr class="separator:a44af1b98e8d986d12107b654453acbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  137. <tr class="memitem:af24917d6e00c8766dab168eb834047ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#af24917d6e00c8766dab168eb834047ec">chvol</a> ()</td></tr>

  138. <tr class="separator:af24917d6e00c8766dab168eb834047ec"><td class="memSeparator" colspan="2">&#160;</td></tr>

  139. <tr class="memitem:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a18446a9c5924304fa7a87d5f03ccaf21">clusterCount</a> () const </td></tr>

  140. <tr class="separator:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memSeparator" colspan="2">&#160;</td></tr>

  141. <tr class="memitem:ac0e63f33d71d5dc95a602834274def6a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ac0e63f33d71d5dc95a602834274def6a">clusterSizeShift</a> () const </td></tr>

  142. <tr class="separator:ac0e63f33d71d5dc95a602834274def6a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  143. <tr class="memitem:a443364af257c219f8e908d5b073d8fa3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a443364af257c219f8e908d5b073d8fa3">dataStartBlock</a> () const </td></tr>

  144. <tr class="separator:a443364af257c219f8e908d5b073d8fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  145. <tr class="memitem:a25c6311b70fa274b3be94ff25fdebba7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a25c6311b70fa274b3be94ff25fdebba7">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>

  146. <tr class="separator:a25c6311b70fa274b3be94ff25fdebba7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  147. <tr class="memitem: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>

  148. <tr class="separator:a905d883dcbaa60aa35a6eb0cad63cc9e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  149. <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>

  150. <tr class="separator:ae8cf95abf0ffb1c7a55eb1a192c28982"><td class="memSeparator" colspan="2">&#160;</td></tr>

  151. <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>

  152. <tr class="separator:a07e04b976ffcaf7e9492e50c6e4900a8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  153. <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>

  154. <tr class="separator:a7c52e1a1909c9aa532b8525cf721fd89"><td class="memSeparator" colspan="2">&#160;</td></tr>

  155. <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>

  156. <tr class="separator:a111cecbcc7ea5c068c44051491a77a52"><td class="memSeparator" colspan="2">&#160;</td></tr>

  157. <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>

  158. <tr class="separator:a4c34e68605243269f96122a9cb909004"><td class="memSeparator" colspan="2">&#160;</td></tr>

  159. <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>

  160. <tr class="separator:a2deadc5b8bcdf5710fefba39b895e008"><td class="memSeparator" colspan="2">&#160;</td></tr>

  161. <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>

  162. <tr class="separator:aaa950f290e41c0ff2d62b94cb425ba12"><td class="memSeparator" colspan="2">&#160;</td></tr>

  163. <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>

  164. <tr class="separator:a84fe32d89460471cf9f66495f545e2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>

  165. <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>

  166. <tr class="separator:a5ecc4177c65f8e2837a9ef4d17368a98"><td class="memSeparator" colspan="2">&#160;</td></tr>

  167. <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>

  168. <tr class="separator:a7eed2449f96d62e87bea96c6da4f618a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  169. <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>

  170. <tr class="separator:aace11e097b69144a80a4abbca54d35b0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  171. <tr class="memitem:aee58c6352652f216577196e32a594b67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aee58c6352652f216577196e32a594b67">exists</a> (const char *path)</td></tr>

  172. <tr class="separator:aee58c6352652f216577196e32a594b67"><td class="memSeparator" colspan="2">&#160;</td></tr>

  173. <tr class="memitem:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#acdedc6a200b01e401c9cd9b511eae6ec">fatCount</a> ()</td></tr>

  174. <tr class="separator:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memSeparator" colspan="2">&#160;</td></tr>

  175. <tr class="memitem:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a0dd0cc689b63ef0702aed1cf36b1722d">fatStartBlock</a> () const </td></tr>

  176. <tr class="separator:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  177. <tr class="memitem:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1364f11fe9bb4717ce0685e2b7b86027">fatType</a> () const </td></tr>

  178. <tr class="separator:a1364f11fe9bb4717ce0685e2b7b86027"><td class="memSeparator" colspan="2">&#160;</td></tr>

  179. <tr class="memitem:a1683b063fc6202ab85470b9610f16f93"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a1683b063fc6202ab85470b9610f16f93">freeClusterCount</a> ()</td></tr>

  180. <tr class="separator:a1683b063fc6202ab85470b9610f16f93"><td class="memSeparator" colspan="2">&#160;</td></tr>

  181. <tr class="memitem: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>

  182. <tr class="separator:a389f0ef6fb556c67b48ade5c0c1b3a9a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  183. <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>

  184. <tr class="separator:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memSeparator" colspan="2">&#160;</td></tr>

  185. <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>

  186. <tr class="separator:a034d997a1e7a0b2b664a4357bcccd256"><td class="memSeparator" colspan="2">&#160;</td></tr>

  187. <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>

  188. <tr class="separator:adbfd9264f972f054e561128bad0b267e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  189. <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>

  190. <tr class="separator:a86770dd889bffc5788172c8d34a3582c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  191. <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>

  192. <tr class="separator:a0d4c851a3243c9f8c21d3894821292e9"><td class="memSeparator" colspan="2">&#160;</td></tr>

  193. <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>

  194. <tr class="separator:a02f18794078b7a1c9662c3ded438cff4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  195. <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>

  196. <tr class="separator:abe312251854aebf5b8d6b4f9896660ed"><td class="memSeparator" colspan="2">&#160;</td></tr>

  197. <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>

  198. <tr class="separator:aa93c7fec40b37e7f5dd1e362ebf5ff69"><td class="memSeparator" colspan="2">&#160;</td></tr>

  199. <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>

  200. <tr class="separator:a62a979138be1b62942f7b3f04964356e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  201. <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>

  202. <tr class="separator:adffd5a3e802842b371b170c6df6b2530"><td class="memSeparator" colspan="2">&#160;</td></tr>

  203. <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>

  204. <tr class="separator:a296855ca8cc7590b9cbe7b3aeabc8467"><td class="memSeparator" colspan="2">&#160;</td></tr>

  205. <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>

  206. <tr class="separator:aca07f92b3a06ede0e7a56b68b76dc3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  207. <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>

  208. <tr class="separator:a9c334faf236651db265d5acf65271666"><td class="memSeparator" colspan="2">&#160;</td></tr>

  209. <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>

  210. <tr class="separator:ac0b7161c1385841264323ac244f5c89c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  211. <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>

  212. <tr class="separator:a2398fb37a7a9d5e0dc0ffde6a44a993d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  213. <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>

  214. <tr class="separator:a122b61dbec5051304bcc81bc08b1b99d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  215. <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>

  216. <tr class="separator:ad17f2a0925b34cb3807e4c1677a2872f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  217. <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>

  218. <tr class="separator:aa79695db8e910300507210b3067d39fd"><td class="memSeparator" colspan="2">&#160;</td></tr>

  219. <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>

  220. <tr class="separator:a231c62c98ba8ac3c2624dc5ad2053ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>

  221. <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>

  222. <tr class="separator:a947e4586077a922892b632edac33b67a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  223. <tr class="memitem:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#abf7d7d0dab43083d5be10d70ff4669e4">remove</a> (const char *path)</td></tr>

  224. <tr class="separator:abf7d7d0dab43083d5be10d70ff4669e4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  225. <tr class="memitem:a0187891a24017b41bd7c5ba63e659e65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0187891a24017b41bd7c5ba63e659e65">rename</a> (const char *oldPath, const char *newPath)</td></tr>

  226. <tr class="separator:a0187891a24017b41bd7c5ba63e659e65"><td class="memSeparator" colspan="2">&#160;</td></tr>

  227. <tr class="memitem:aaed2edc7ff7fedb163458c870bb41b33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#aaed2edc7ff7fedb163458c870bb41b33">rmdir</a> (const char *path)</td></tr>

  228. <tr class="separator:aaed2edc7ff7fedb163458c870bb41b33"><td class="memSeparator" colspan="2">&#160;</td></tr>

  229. <tr class="memitem:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab2d483670a0a6a6a4754b23614fe11bc">rootDirEntryCount</a> () const </td></tr>

  230. <tr class="separator:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  231. <tr class="memitem:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae9363ebbbae90e895ea56e8fa3f60c13">rootDirStart</a> () const </td></tr>

  232. <tr class="separator:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memSeparator" colspan="2">&#160;</td></tr>

  233. <tr class="memitem: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>

  234. <tr class="separator:ad60cb13557f35578f868e03e9ccb8be1"><td class="memSeparator" colspan="2">&#160;</td></tr>

  235. <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>

  236. <tr class="separator:a4ca68fe47bb675df0a80df1ed7a53698"><td class="memSeparator" colspan="2">&#160;</td></tr>

  237. <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>

  238. <tr class="separator:a07bc98088ce4a9c725700899c184f7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  239. <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>

  240. <tr class="separator:acf257d02b7166683bda2abc5058004bf"><td class="memSeparator" colspan="2">&#160;</td></tr>

  241. <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>

  242. <tr class="separator:a36d7831f92acfbfef1c4a24dd7103dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  243. </table>

  244. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  245. <div class="textblock"><p>Virtual base class for SdFat library. </p>

  246. </div><h2 class="groupheader">Member Function Documentation</h2>

  247. <a class="anchor" id="a05bd3d358a708efe2f9002d05c3a4139"></a>

  248. <div class="memitem">

  249. <div class="memproto">

  250. <table class="mlabels">

  251.   <tr>

  252.   <td class="mlabels-left">

  253.       <table class="memname">

  254.         <tr>

  255.           <td class="memname">bool FatFileSystem::begin </td>

  256.           <td>(</td>

  257.           <td class="paramtype">uint8_t&#160;</td>

  258.           <td class="paramname"><em>part</em> = <code>0</code></td><td>)</td>

  259.           <td></td>

  260.         </tr>

  261.       </table>

  262.   </td>

  263.   <td class="mlabels-right">

  264. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  265.   </tr>

  266. </table>

  267. </div><div class="memdoc">

  268. <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>

  269.   <table class="params">

  270.     <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>partition to initialize. </td></tr>

  271.   </table>

  272.   </dd>

  273. </dl>

  274. <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>

  275. 

  276. </div>

  277. </div>

  278. <a class="anchor" id="a3d3f2cc4df1b6f2a129c3a614c1e5e1f"></a>

  279. <div class="memitem">

  280. <div class="memproto">

  281. <table class="mlabels">

  282.   <tr>

  283.   <td class="mlabels-left">

  284.       <table class="memname">

  285.         <tr>

  286.           <td class="memname">bool SdFatBase::begin </td>

  287.           <td>(</td>

  288.           <td class="paramtype"><a class="el" href="class_sd_spi_card.html#a31a561750501b6635ad2b85c8c960381">SdSpiCard::m_spi_t</a> *&#160;</td>

  289.           <td class="paramname"><em>spi</em>, </td>

  290.         </tr>

  291.         <tr>

  292.           <td class="paramkey"></td>

  293.           <td></td>

  294.           <td class="paramtype">uint8_t&#160;</td>

  295.           <td class="paramname"><em>csPin</em> = <code>SS</code>, </td>

  296.         </tr>

  297.         <tr>

  298.           <td class="paramkey"></td>

  299.           <td></td>

  300.           <td class="paramtype">uint8_t&#160;</td>

  301.           <td class="paramname"><em>divisor</em> = <code>2</code>&#160;</td>

  302.         </tr>

  303.         <tr>

  304.           <td></td>

  305.           <td>)</td>

  306.           <td></td><td></td>

  307.         </tr>

  308.       </table>

  309.   </td>

  310.   <td class="mlabels-right">

  311. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  312.   </tr>

  313. </table>

  314. </div><div class="memdoc">

  315. <p>Initialize SD card and file system. </p><dl class="params"><dt>Parameters</dt><dd>

  316.   <table class="params">

  317.     <tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>SPI object for the card. </td></tr>

  318.     <tr><td class="paramdir">[in]</td><td class="paramname">csPin</td><td>SD card chip select pin. </td></tr>

  319.     <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SPI divisor. </td></tr>

  320.   </table>

  321.   </dd>

  322. </dl>

  323. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  324. 

  325. </div>

  326. </div>

  327. <a class="anchor" id="a06beed4cea5e38116b58254a57125442"></a>

  328. <div class="memitem">

  329. <div class="memproto">

  330. <table class="mlabels">

  331.   <tr>

  332.   <td class="mlabels-left">

  333.       <table class="memname">

  334.         <tr>

  335.           <td class="memname">uint8_t FatVolume::blocksPerCluster </td>

  336.           <td>(</td>

  337.           <td class="paramname"></td><td>)</td>

  338.           <td> const</td>

  339.         </tr>

  340.       </table>

  341.   </td>

  342.   <td class="mlabels-right">

  343. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  344.   </tr>

  345. </table>

  346. </div><div class="memdoc">

  347. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>

  348. 

  349. </div>

  350. </div>

  351. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></a>

  352. <div class="memitem">

  353. <div class="memproto">

  354. <table class="mlabels">

  355.   <tr>

  356.   <td class="mlabels-left">

  357.       <table class="memname">

  358.         <tr>

  359.           <td class="memname">uint32_t FatVolume::blocksPerFat </td>

  360.           <td>(</td>

  361.           <td class="paramname"></td><td>)</td>

  362.           <td> const</td>

  363.         </tr>

  364.       </table>

  365.   </td>

  366.   <td class="mlabels-right">

  367. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  368.   </tr>

  369. </table>

  370. </div><div class="memdoc">

  371. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>

  372. 

  373. </div>

  374. </div>

  375. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></a>

  376. <div class="memitem">

  377. <div class="memproto">

  378. <table class="mlabels">

  379.   <tr>

  380.   <td class="mlabels-left">

  381.       <table class="memname">

  382.         <tr>

  383.           <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>

  384.           <td>(</td>

  385.           <td class="paramname"></td><td>)</td>

  386.           <td></td>

  387.         </tr>

  388.       </table>

  389.   </td>

  390.   <td class="mlabels-right">

  391. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  392.   </tr>

  393. </table>

  394. </div><div class="memdoc">

  395. <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>

  396. 

  397. </div>

  398. </div>

  399. <a class="anchor" id="a899294ced4e4585feae7668099338534"></a>

  400. <div class="memitem">

  401. <div class="memproto">

  402. <table class="mlabels">

  403.   <tr>

  404.   <td class="mlabels-left">

  405.       <table class="memname">

  406.         <tr>

  407.           <td class="memname"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a>* SdFatBase::card </td>

  408.           <td>(</td>

  409.           <td class="paramname"></td><td>)</td>

  410.           <td></td>

  411.         </tr>

  412.       </table>

  413.   </td>

  414.   <td class="mlabels-right">

  415. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  416.   </tr>

  417. </table>

  418. </div><div class="memdoc">

  419. <dl class="section return"><dt>Returns</dt><dd>Pointer to SD card object </dd></dl>

  420. 

  421. </div>

  422. </div>

  423. <a class="anchor" id="a5667915e63187a43a71dfada63800865"></a>

  424. <div class="memitem">

  425. <div class="memproto">

  426. <table class="mlabels">

  427.   <tr>

  428.   <td class="mlabels-left">

  429.       <table class="memname">

  430.         <tr>

  431.           <td class="memname">bool FatFileSystem::chdir </td>

  432.           <td>(</td>

  433.           <td class="paramtype">bool&#160;</td>

  434.           <td class="paramname"><em>set_cwd</em> = <code>false</code></td><td>)</td>

  435.           <td></td>

  436.         </tr>

  437.       </table>

  438.   </td>

  439.   <td class="mlabels-right">

  440. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  441.   </tr>

  442. </table>

  443. </div><div class="memdoc">

  444. <p>Change a volume's working directory to root</p>

  445. <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>

  446. <dl class="params"><dt>Parameters</dt><dd>

  447.   <table class="params">

  448.     <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>

  449.   </table>

  450.   </dd>

  451. </dl>

  452. <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>

  453. 

  454. </div>

  455. </div>

  456. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></a>

  457. <div class="memitem">

  458. <div class="memproto">

  459. <table class="mlabels">

  460.   <tr>

  461.   <td class="mlabels-left">

  462.       <table class="memname">

  463.         <tr>

  464.           <td class="memname">bool FatFileSystem::chdir </td>

  465.           <td>(</td>

  466.           <td class="paramtype">const char *&#160;</td>

  467.           <td class="paramname"><em>path</em>, </td>

  468.         </tr>

  469.         <tr>

  470.           <td class="paramkey"></td>

  471.           <td></td>

  472.           <td class="paramtype">bool&#160;</td>

  473.           <td class="paramname"><em>set_cwd</em> = <code>false</code>&#160;</td>

  474.         </tr>

  475.         <tr>

  476.           <td></td>

  477.           <td>)</td>

  478.           <td></td><td></td>

  479.         </tr>

  480.       </table>

  481.   </td>

  482.   <td class="mlabels-right">

  483. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  484.   </tr>

  485. </table>

  486. </div><div class="memdoc">

  487. <p>Change a volume's working directory</p>

  488. <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>

  489. <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>

  490. <p>If path is "/", the volume's working directory will be changed to the root directory</p>

  491. <dl class="params"><dt>Parameters</dt><dd>

  492.   <table class="params">

  493.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The name of the subdirectory.</td></tr>

  494.     <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>

  495.   </table>

  496.   </dd>

  497. </dl>

  498. <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>

  499. 

  500. </div>

  501. </div>

  502. <a class="anchor" id="af24917d6e00c8766dab168eb834047ec"></a>

  503. <div class="memitem">

  504. <div class="memproto">

  505. <table class="mlabels">

  506.   <tr>

  507.   <td class="mlabels-left">

  508.       <table class="memname">

  509.         <tr>

  510.           <td class="memname">void FatFileSystem::chvol </td>

  511.           <td>(</td>

  512.           <td class="paramname"></td><td>)</td>

  513.           <td></td>

  514.         </tr>

  515.       </table>

  516.   </td>

  517.   <td class="mlabels-right">

  518. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  519.   </tr>

  520. </table>

  521. </div><div class="memdoc">

  522. <p>Set the current working directory to a volume's working directory.</p>

  523. <p>This is useful with multiple SD cards.</p>

  524. <p>The current working directory is changed to this volume's working directory.</p>

  525. <p>This is like the Windows/DOS &lt;drive letter&gt;: command. </p>

  526. 

  527. </div>

  528. </div>

  529. <a class="anchor" id="a18446a9c5924304fa7a87d5f03ccaf21"></a>

  530. <div class="memitem">

  531. <div class="memproto">

  532. <table class="mlabels">

  533.   <tr>

  534.   <td class="mlabels-left">

  535.       <table class="memname">

  536.         <tr>

  537.           <td class="memname">uint32_t FatVolume::clusterCount </td>

  538.           <td>(</td>

  539.           <td class="paramname"></td><td>)</td>

  540.           <td> const</td>

  541.         </tr>

  542.       </table>

  543.   </td>

  544.   <td class="mlabels-right">

  545. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  546.   </tr>

  547. </table>

  548. </div><div class="memdoc">

  549. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>

  550. 

  551. </div>

  552. </div>

  553. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></a>

  554. <div class="memitem">

  555. <div class="memproto">

  556. <table class="mlabels">

  557.   <tr>

  558.   <td class="mlabels-left">

  559.       <table class="memname">

  560.         <tr>

  561.           <td class="memname">uint8_t FatVolume::clusterSizeShift </td>

  562.           <td>(</td>

  563.           <td class="paramname"></td><td>)</td>

  564.           <td> const</td>

  565.         </tr>

  566.       </table>

  567.   </td>

  568.   <td class="mlabels-right">

  569. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  570.   </tr>

  571. </table>

  572. </div><div class="memdoc">

  573. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>

  574. 

  575. </div>

  576. </div>

  577. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></a>

  578. <div class="memitem">

  579. <div class="memproto">

  580. <table class="mlabels">

  581.   <tr>

  582.   <td class="mlabels-left">

  583.       <table class="memname">

  584.         <tr>

  585.           <td class="memname">uint32_t FatVolume::dataStartBlock </td>

  586.           <td>(</td>

  587.           <td class="paramname"></td><td>)</td>

  588.           <td> const</td>

  589.         </tr>

  590.       </table>

  591.   </td>

  592.   <td class="mlabels-right">

  593. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  594.   </tr>

  595. </table>

  596. </div><div class="memdoc">

  597. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>

  598. 

  599. </div>

  600. </div>

  601. <a class="anchor" id="a25c6311b70fa274b3be94ff25fdebba7"></a>

  602. <div class="memitem">

  603. <div class="memproto">

  604. <table class="mlabels">

  605.   <tr>

  606.   <td class="mlabels-left">

  607.       <table class="memname">

  608.         <tr>

  609.           <td class="memname">int8_t FatVolume::dbgFat </td>

  610.           <td>(</td>

  611.           <td class="paramtype">uint32_t&#160;</td>

  612.           <td class="paramname"><em>n</em>, </td>

  613.         </tr>

  614.         <tr>

  615.           <td class="paramkey"></td>

  616.           <td></td>

  617.           <td class="paramtype">uint32_t *&#160;</td>

  618.           <td class="paramname"><em>v</em>&#160;</td>

  619.         </tr>

  620.         <tr>

  621.           <td></td>

  622.           <td>)</td>

  623.           <td></td><td></td>

  624.         </tr>

  625.       </table>

  626.   </td>

  627.   <td class="mlabels-right">

  628. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  629.   </tr>

  630. </table>

  631. </div><div class="memdoc">

  632. <p>Debug access to FAT table</p>

  633. <dl class="params"><dt>Parameters</dt><dd>

  634.   <table class="params">

  635.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>

  636.     <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>

  637.   </table>

  638.   </dd>

  639. </dl>

  640. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>

  641. 

  642. </div>

  643. </div>

  644. <a class="anchor" id="a905d883dcbaa60aa35a6eb0cad63cc9e"></a>

  645. <div class="memitem">

  646. <div class="memproto">

  647. <table class="mlabels">

  648.   <tr>

  649.   <td class="mlabels-left">

  650.       <table class="memname">

  651.         <tr>

  652.           <td class="memname">void SdFatBase::errorHalt </td>

  653.           <td>(</td>

  654.           <td class="paramname"></td><td>)</td>

  655.           <td></td>

  656.         </tr>

  657.       </table>

  658.   </td>

  659.   <td class="mlabels-right">

  660. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  661.   </tr>

  662. </table>

  663. </div><div class="memdoc">

  664. <p>Print any SD error code to Serial and halt. </p>

  665. 

  666. </div>

  667. </div>

  668. <a class="anchor" id="ae8cf95abf0ffb1c7a55eb1a192c28982"></a>

  669. <div class="memitem">

  670. <div class="memproto">

  671.       <table class="memname">

  672.         <tr>

  673.           <td class="memname">void SdFatBase::errorHalt </td>

  674.           <td>(</td>

  675.           <td class="paramtype">Print *&#160;</td>

  676.           <td class="paramname"><em>pr</em></td><td>)</td>

  677.           <td></td>

  678.         </tr>

  679.       </table>

  680. </div><div class="memdoc">

  681. <p>Print any SD error code and halt.</p>

  682. <dl class="params"><dt>Parameters</dt><dd>

  683.   <table class="params">

  684.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  685.   </table>

  686.   </dd>

  687. </dl>

  688. 

  689. </div>

  690. </div>

  691. <a class="anchor" id="a07e04b976ffcaf7e9492e50c6e4900a8"></a>

  692. <div class="memitem">

  693. <div class="memproto">

  694. <table class="mlabels">

  695.   <tr>

  696.   <td class="mlabels-left">

  697.       <table class="memname">

  698.         <tr>

  699.           <td class="memname">void SdFatBase::errorHalt </td>

  700.           <td>(</td>

  701.           <td class="paramtype">char const *&#160;</td>

  702.           <td class="paramname"><em>msg</em></td><td>)</td>

  703.           <td></td>

  704.         </tr>

  705.       </table>

  706.   </td>

  707.   <td class="mlabels-right">

  708. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  709.   </tr>

  710. </table>

  711. </div><div class="memdoc">

  712. <p>Print msg, any SD error code and halt.</p>

  713. <dl class="params"><dt>Parameters</dt><dd>

  714.   <table class="params">

  715.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  716.   </table>

  717.   </dd>

  718. </dl>

  719. 

  720. </div>

  721. </div>

  722. <a class="anchor" id="a7c52e1a1909c9aa532b8525cf721fd89"></a>

  723. <div class="memitem">

  724. <div class="memproto">

  725.       <table class="memname">

  726.         <tr>

  727.           <td class="memname">void SdFatBase::errorHalt </td>

  728.           <td>(</td>

  729.           <td class="paramtype">Print *&#160;</td>

  730.           <td class="paramname"><em>pr</em>, </td>

  731.         </tr>

  732.         <tr>

  733.           <td class="paramkey"></td>

  734.           <td></td>

  735.           <td class="paramtype">char const *&#160;</td>

  736.           <td class="paramname"><em>msg</em>&#160;</td>

  737.         </tr>

  738.         <tr>

  739.           <td></td>

  740.           <td>)</td>

  741.           <td></td><td></td>

  742.         </tr>

  743.       </table>

  744. </div><div class="memdoc">

  745. <p>Print msg, any SD error code, and halt.</p>

  746. <dl class="params"><dt>Parameters</dt><dd>

  747.   <table class="params">

  748.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  749.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  750.   </table>

  751.   </dd>

  752. </dl>

  753. 

  754. </div>

  755. </div>

  756. <a class="anchor" id="a111cecbcc7ea5c068c44051491a77a52"></a>

  757. <div class="memitem">

  758. <div class="memproto">

  759. <table class="mlabels">

  760.   <tr>

  761.   <td class="mlabels-left">

  762.       <table class="memname">

  763.         <tr>

  764.           <td class="memname">void SdFatBase::errorHalt </td>

  765.           <td>(</td>

  766.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  767.           <td class="paramname"><em>msg</em></td><td>)</td>

  768.           <td></td>

  769.         </tr>

  770.       </table>

  771.   </td>

  772.   <td class="mlabels-right">

  773. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  774.   </tr>

  775. </table>

  776. </div><div class="memdoc">

  777. <p>Print msg, any SD error code, and halt.</p>

  778. <dl class="params"><dt>Parameters</dt><dd>

  779.   <table class="params">

  780.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  781.   </table>

  782.   </dd>

  783. </dl>

  784. 

  785. </div>

  786. </div>

  787. <a class="anchor" id="a4c34e68605243269f96122a9cb909004"></a>

  788. <div class="memitem">

  789. <div class="memproto">

  790.       <table class="memname">

  791.         <tr>

  792.           <td class="memname">void SdFatBase::errorHalt </td>

  793.           <td>(</td>

  794.           <td class="paramtype">Print *&#160;</td>

  795.           <td class="paramname"><em>pr</em>, </td>

  796.         </tr>

  797.         <tr>

  798.           <td class="paramkey"></td>

  799.           <td></td>

  800.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  801.           <td class="paramname"><em>msg</em>&#160;</td>

  802.         </tr>

  803.         <tr>

  804.           <td></td>

  805.           <td>)</td>

  806.           <td></td><td></td>

  807.         </tr>

  808.       </table>

  809. </div><div class="memdoc">

  810. <p>Print msg, any SD error code, and halt.</p>

  811. <dl class="params"><dt>Parameters</dt><dd>

  812.   <table class="params">

  813.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  814.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  815.   </table>

  816.   </dd>

  817. </dl>

  818. 

  819. </div>

  820. </div>

  821. <a class="anchor" id="a2deadc5b8bcdf5710fefba39b895e008"></a>

  822. <div class="memitem">

  823. <div class="memproto">

  824. <table class="mlabels">

  825.   <tr>

  826.   <td class="mlabels-left">

  827.       <table class="memname">

  828.         <tr>

  829.           <td class="memname">void SdFatBase::errorPrint </td>

  830.           <td>(</td>

  831.           <td class="paramname"></td><td>)</td>

  832.           <td></td>

  833.         </tr>

  834.       </table>

  835.   </td>

  836.   <td class="mlabels-right">

  837. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  838.   </tr>

  839. </table>

  840. </div><div class="memdoc">

  841. <p>Print any SD error code to Serial </p>

  842. 

  843. </div>

  844. </div>

  845. <a class="anchor" id="aaa950f290e41c0ff2d62b94cb425ba12"></a>

  846. <div class="memitem">

  847. <div class="memproto">

  848.       <table class="memname">

  849.         <tr>

  850.           <td class="memname">void SdFatBase::errorPrint </td>

  851.           <td>(</td>

  852.           <td class="paramtype">Print *&#160;</td>

  853.           <td class="paramname"><em>pr</em></td><td>)</td>

  854.           <td></td>

  855.         </tr>

  856.       </table>

  857. </div><div class="memdoc">

  858. <p>Print any SD error code. </p><dl class="params"><dt>Parameters</dt><dd>

  859.   <table class="params">

  860.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>

  861.   </table>

  862.   </dd>

  863. </dl>

  864. 

  865. </div>

  866. </div>

  867. <a class="anchor" id="a84fe32d89460471cf9f66495f545e2ae"></a>

  868. <div class="memitem">

  869. <div class="memproto">

  870. <table class="mlabels">

  871.   <tr>

  872.   <td class="mlabels-left">

  873.       <table class="memname">

  874.         <tr>

  875.           <td class="memname">void SdFatBase::errorPrint </td>

  876.           <td>(</td>

  877.           <td class="paramtype">const char *&#160;</td>

  878.           <td class="paramname"><em>msg</em></td><td>)</td>

  879.           <td></td>

  880.         </tr>

  881.       </table>

  882.   </td>

  883.   <td class="mlabels-right">

  884. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  885.   </tr>

  886. </table>

  887. </div><div class="memdoc">

  888. <p>Print msg, any SD error code.</p>

  889. <dl class="params"><dt>Parameters</dt><dd>

  890.   <table class="params">

  891.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  892.   </table>

  893.   </dd>

  894. </dl>

  895. 

  896. </div>

  897. </div>

  898. <a class="anchor" id="a5ecc4177c65f8e2837a9ef4d17368a98"></a>

  899. <div class="memitem">

  900. <div class="memproto">

  901.       <table class="memname">

  902.         <tr>

  903.           <td class="memname">void SdFatBase::errorPrint </td>

  904.           <td>(</td>

  905.           <td class="paramtype">Print *&#160;</td>

  906.           <td class="paramname"><em>pr</em>, </td>

  907.         </tr>

  908.         <tr>

  909.           <td class="paramkey"></td>

  910.           <td></td>

  911.           <td class="paramtype">char const *&#160;</td>

  912.           <td class="paramname"><em>msg</em>&#160;</td>

  913.         </tr>

  914.         <tr>

  915.           <td></td>

  916.           <td>)</td>

  917.           <td></td><td></td>

  918.         </tr>

  919.       </table>

  920. </div><div class="memdoc">

  921. <p>Print msg, any SD error code.</p>

  922. <dl class="params"><dt>Parameters</dt><dd>

  923.   <table class="params">

  924.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  925.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  926.   </table>

  927.   </dd>

  928. </dl>

  929. 

  930. </div>

  931. </div>

  932. <a class="anchor" id="a7eed2449f96d62e87bea96c6da4f618a"></a>

  933. <div class="memitem">

  934. <div class="memproto">

  935. <table class="mlabels">

  936.   <tr>

  937.   <td class="mlabels-left">

  938.       <table class="memname">

  939.         <tr>

  940.           <td class="memname">void SdFatBase::errorPrint </td>

  941.           <td>(</td>

  942.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  943.           <td class="paramname"><em>msg</em></td><td>)</td>

  944.           <td></td>

  945.         </tr>

  946.       </table>

  947.   </td>

  948.   <td class="mlabels-right">

  949. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  950.   </tr>

  951. </table>

  952. </div><div class="memdoc">

  953. <p>Print msg, any SD error code.</p>

  954. <dl class="params"><dt>Parameters</dt><dd>

  955.   <table class="params">

  956.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  957.   </table>

  958.   </dd>

  959. </dl>

  960. 

  961. </div>

  962. </div>

  963. <a class="anchor" id="aace11e097b69144a80a4abbca54d35b0"></a>

  964. <div class="memitem">

  965. <div class="memproto">

  966.       <table class="memname">

  967.         <tr>

  968.           <td class="memname">void SdFatBase::errorPrint </td>

  969.           <td>(</td>

  970.           <td class="paramtype">Print *&#160;</td>

  971.           <td class="paramname"><em>pr</em>, </td>

  972.         </tr>

  973.         <tr>

  974.           <td class="paramkey"></td>

  975.           <td></td>

  976.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  977.           <td class="paramname"><em>msg</em>&#160;</td>

  978.         </tr>

  979.         <tr>

  980.           <td></td>

  981.           <td>)</td>

  982.           <td></td><td></td>

  983.         </tr>

  984.       </table>

  985. </div><div class="memdoc">

  986. <p>Print msg, any SD error code.</p>

  987. <dl class="params"><dt>Parameters</dt><dd>

  988.   <table class="params">

  989.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  990.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  991.   </table>

  992.   </dd>

  993. </dl>

  994. 

  995. </div>

  996. </div>

  997. <a class="anchor" id="aee58c6352652f216577196e32a594b67"></a>

  998. <div class="memitem">

  999. <div class="memproto">

  1000. <table class="mlabels">

  1001.   <tr>

  1002.   <td class="mlabels-left">

  1003.       <table class="memname">

  1004.         <tr>

  1005.           <td class="memname">bool FatFileSystem::exists </td>

  1006.           <td>(</td>

  1007.           <td class="paramtype">const char *&#160;</td>

  1008.           <td class="paramname"><em>path</em></td><td>)</td>

  1009.           <td></td>

  1010.         </tr>

  1011.       </table>

  1012.   </td>

  1013.   <td class="mlabels-right">

  1014. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1015.   </tr>

  1016. </table>

  1017. </div><div class="memdoc">

  1018. <p>Test for the existence of a file.</p>

  1019. <dl class="params"><dt>Parameters</dt><dd>

  1020.   <table class="params">

  1021.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path of the file to be tested for.</td></tr>

  1022.   </table>

  1023.   </dd>

  1024. </dl>

  1025. <dl class="section return"><dt>Returns</dt><dd>true if the file exists else false. </dd></dl>

  1026. 

  1027. </div>

  1028. </div>

  1029. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></a>

  1030. <div class="memitem">

  1031. <div class="memproto">

  1032. <table class="mlabels">

  1033.   <tr>

  1034.   <td class="mlabels-left">

  1035.       <table class="memname">

  1036.         <tr>

  1037.           <td class="memname">uint8_t FatVolume::fatCount </td>

  1038.           <td>(</td>

  1039.           <td class="paramname"></td><td>)</td>

  1040.           <td></td>

  1041.         </tr>

  1042.       </table>

  1043.   </td>

  1044.   <td class="mlabels-right">

  1045. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1046.   </tr>

  1047. </table>

  1048. </div><div class="memdoc">

  1049. <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>

  1050. 

  1051. </div>

  1052. </div>

  1053. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></a>

  1054. <div class="memitem">

  1055. <div class="memproto">

  1056. <table class="mlabels">

  1057.   <tr>

  1058.   <td class="mlabels-left">

  1059.       <table class="memname">

  1060.         <tr>

  1061.           <td class="memname">uint32_t FatVolume::fatStartBlock </td>

  1062.           <td>(</td>

  1063.           <td class="paramname"></td><td>)</td>

  1064.           <td> const</td>

  1065.         </tr>

  1066.       </table>

  1067.   </td>

  1068.   <td class="mlabels-right">

  1069. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1070.   </tr>

  1071. </table>

  1072. </div><div class="memdoc">

  1073. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>

  1074. 

  1075. </div>

  1076. </div>

  1077. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></a>

  1078. <div class="memitem">

  1079. <div class="memproto">

  1080. <table class="mlabels">

  1081.   <tr>

  1082.   <td class="mlabels-left">

  1083.       <table class="memname">

  1084.         <tr>

  1085.           <td class="memname">uint8_t FatVolume::fatType </td>

  1086.           <td>(</td>

  1087.           <td class="paramname"></td><td>)</td>

  1088.           <td> const</td>

  1089.         </tr>

  1090.       </table>

  1091.   </td>

  1092.   <td class="mlabels-right">

  1093. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1094.   </tr>

  1095. </table>

  1096. </div><div class="memdoc">

  1097. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>

  1098. 

  1099. </div>

  1100. </div>

  1101. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></a>

  1102. <div class="memitem">

  1103. <div class="memproto">

  1104. <table class="mlabels">

  1105.   <tr>

  1106.   <td class="mlabels-left">

  1107.       <table class="memname">

  1108.         <tr>

  1109.           <td class="memname">int32_t FatVolume::freeClusterCount </td>

  1110.           <td>(</td>

  1111.           <td class="paramname"></td><td>)</td>

  1112.           <td></td>

  1113.         </tr>

  1114.       </table>

  1115.   </td>

  1116.   <td class="mlabels-right">

  1117. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1118.   </tr>

  1119. </table>

  1120. </div><div class="memdoc">

  1121. <p>Volume free space in clusters.</p>

  1122. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>

  1123. 

  1124. </div>

  1125. </div>

  1126. <a class="anchor" id="a389f0ef6fb556c67b48ade5c0c1b3a9a"></a>

  1127. <div class="memitem">

  1128. <div class="memproto">

  1129. <table class="mlabels">

  1130.   <tr>

  1131.   <td class="mlabels-left">

  1132.       <table class="memname">

  1133.         <tr>

  1134.           <td class="memname">bool SdFatBase::fsBegin </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>  </td>

  1143.   </tr>

  1144. </table>

  1145. </div><div class="memdoc">

  1146. <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>

  1147. 

  1148. </div>

  1149. </div>

  1150. <a class="anchor" id="acab819fa25a91dad1cc698a7e1e0eb32"></a>

  1151. <div class="memitem">

  1152. <div class="memproto">

  1153. <table class="mlabels">

  1154.   <tr>

  1155.   <td class="mlabels-left">

  1156.       <table class="memname">

  1157.         <tr>

  1158.           <td class="memname">bool FatVolume::init </td>

  1159.           <td>(</td>

  1160.           <td class="paramname"></td><td>)</td>

  1161.           <td></td>

  1162.         </tr>

  1163.       </table>

  1164.   </td>

  1165.   <td class="mlabels-right">

  1166. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1167.   </tr>

  1168. </table>

  1169. </div><div class="memdoc">

  1170. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>

  1171. <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>

  1172. 

  1173. </div>

  1174. </div>

  1175. <a class="anchor" id="a034d997a1e7a0b2b664a4357bcccd256"></a>

  1176. <div class="memitem">

  1177. <div class="memproto">

  1178. <table class="mlabels">

  1179.   <tr>

  1180.   <td class="mlabels-left">

  1181.       <table class="memname">

  1182.         <tr>

  1183.           <td class="memname">bool FatVolume::init </td>

  1184.           <td>(</td>

  1185.           <td class="paramtype">uint8_t&#160;</td>

  1186.           <td class="paramname"><em>part</em></td><td>)</td>

  1187.           <td></td>

  1188.         </tr>

  1189.       </table>

  1190.   </td>

  1191.   <td class="mlabels-right">

  1192. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  1193.   </tr>

  1194. </table>

  1195. </div><div class="memdoc">

  1196. <p>Initialize a FAT volume.</p>

  1197. <dl class="params"><dt>Parameters</dt><dd>

  1198.   <table class="params">

  1199.     <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>

  1200.   </table>

  1201.   </dd>

  1202. </dl>

  1203. <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>

  1204. 

  1205. </div>

  1206. </div>

  1207. <a class="anchor" id="adbfd9264f972f054e561128bad0b267e"></a>

  1208. <div class="memitem">

  1209. <div class="memproto">

  1210. <table class="mlabels">

  1211.   <tr>

  1212.   <td class="mlabels-left">

  1213.       <table class="memname">

  1214.         <tr>

  1215.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1216.           <td>(</td>

  1217.           <td class="paramname"></td><td>)</td>

  1218.           <td></td>

  1219.         </tr>

  1220.       </table>

  1221.   </td>

  1222.   <td class="mlabels-right">

  1223. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1224.   </tr>

  1225. </table>

  1226. </div><div class="memdoc">

  1227. <p>Print any SD error code and halt. </p>

  1228. 

  1229. </div>

  1230. </div>

  1231. <a class="anchor" id="a86770dd889bffc5788172c8d34a3582c"></a>

  1232. <div class="memitem">

  1233. <div class="memproto">

  1234.       <table class="memname">

  1235.         <tr>

  1236.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1237.           <td>(</td>

  1238.           <td class="paramtype">Print *&#160;</td>

  1239.           <td class="paramname"><em>pr</em></td><td>)</td>

  1240.           <td></td>

  1241.         </tr>

  1242.       </table>

  1243. </div><div class="memdoc">

  1244. <p>Print error details and halt after begin fails.</p>

  1245. <dl class="params"><dt>Parameters</dt><dd>

  1246.   <table class="params">

  1247.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1248.   </table>

  1249.   </dd>

  1250. </dl>

  1251. 

  1252. </div>

  1253. </div>

  1254. <a class="anchor" id="a0d4c851a3243c9f8c21d3894821292e9"></a>

  1255. <div class="memitem">

  1256. <div class="memproto">

  1257. <table class="mlabels">

  1258.   <tr>

  1259.   <td class="mlabels-left">

  1260.       <table class="memname">

  1261.         <tr>

  1262.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1263.           <td>(</td>

  1264.           <td class="paramtype">char const *&#160;</td>

  1265.           <td class="paramname"><em>msg</em></td><td>)</td>

  1266.           <td></td>

  1267.         </tr>

  1268.       </table>

  1269.   </td>

  1270.   <td class="mlabels-right">

  1271. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1272.   </tr>

  1273. </table>

  1274. </div><div class="memdoc">

  1275. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

  1276. <dl class="params"><dt>Parameters</dt><dd>

  1277.   <table class="params">

  1278.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1279.   </table>

  1280.   </dd>

  1281. </dl>

  1282. 

  1283. </div>

  1284. </div>

  1285. <a class="anchor" id="a02f18794078b7a1c9662c3ded438cff4"></a>

  1286. <div class="memitem">

  1287. <div class="memproto">

  1288.       <table class="memname">

  1289.         <tr>

  1290.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1291.           <td>(</td>

  1292.           <td class="paramtype">Print *&#160;</td>

  1293.           <td class="paramname"><em>pr</em>, </td>

  1294.         </tr>

  1295.         <tr>

  1296.           <td class="paramkey"></td>

  1297.           <td></td>

  1298.           <td class="paramtype">char const *&#160;</td>

  1299.           <td class="paramname"><em>msg</em>&#160;</td>

  1300.         </tr>

  1301.         <tr>

  1302.           <td></td>

  1303.           <td>)</td>

  1304.           <td></td><td></td>

  1305.         </tr>

  1306.       </table>

  1307. </div><div class="memdoc">

  1308. <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>

  1309.   <table class="params">

  1310.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device. </td></tr>

  1311.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1312.   </table>

  1313.   </dd>

  1314. </dl>

  1315. 

  1316. </div>

  1317. </div>

  1318. <a class="anchor" id="abe312251854aebf5b8d6b4f9896660ed"></a>

  1319. <div class="memitem">

  1320. <div class="memproto">

  1321. <table class="mlabels">

  1322.   <tr>

  1323.   <td class="mlabels-left">

  1324.       <table class="memname">

  1325.         <tr>

  1326.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1327.           <td>(</td>

  1328.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1329.           <td class="paramname"><em>msg</em></td><td>)</td>

  1330.           <td></td>

  1331.         </tr>

  1332.       </table>

  1333.   </td>

  1334.   <td class="mlabels-right">

  1335. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1336.   </tr>

  1337. </table>

  1338. </div><div class="memdoc">

  1339. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

  1340. <dl class="params"><dt>Parameters</dt><dd>

  1341.   <table class="params">

  1342.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1343.   </table>

  1344.   </dd>

  1345. </dl>

  1346. 

  1347. </div>

  1348. </div>

  1349. <a class="anchor" id="aa93c7fec40b37e7f5dd1e362ebf5ff69"></a>

  1350. <div class="memitem">

  1351. <div class="memproto">

  1352.       <table class="memname">

  1353.         <tr>

  1354.           <td class="memname">void SdFatBase::initErrorHalt </td>

  1355.           <td>(</td>

  1356.           <td class="paramtype">Print *&#160;</td>

  1357.           <td class="paramname"><em>pr</em>, </td>

  1358.         </tr>

  1359.         <tr>

  1360.           <td class="paramkey"></td>

  1361.           <td></td>

  1362.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1363.           <td class="paramname"><em>msg</em>&#160;</td>

  1364.         </tr>

  1365.         <tr>

  1366.           <td></td>

  1367.           <td>)</td>

  1368.           <td></td><td></td>

  1369.         </tr>

  1370.       </table>

  1371. </div><div class="memdoc">

  1372. <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>

  1373.   <table class="params">

  1374.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print device for message. </td></tr>

  1375.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1376.   </table>

  1377.   </dd>

  1378. </dl>

  1379. 

  1380. </div>

  1381. </div>

  1382. <a class="anchor" id="a62a979138be1b62942f7b3f04964356e"></a>

  1383. <div class="memitem">

  1384. <div class="memproto">

  1385. <table class="mlabels">

  1386.   <tr>

  1387.   <td class="mlabels-left">

  1388.       <table class="memname">

  1389.         <tr>

  1390.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1391.           <td>(</td>

  1392.           <td class="paramname"></td><td>)</td>

  1393.           <td></td>

  1394.         </tr>

  1395.       </table>

  1396.   </td>

  1397.   <td class="mlabels-right">

  1398. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1399.   </tr>

  1400. </table>

  1401. </div><div class="memdoc">

  1402. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails. </p>

  1403. 

  1404. </div>

  1405. </div>

  1406. <a class="anchor" id="adffd5a3e802842b371b170c6df6b2530"></a>

  1407. <div class="memitem">

  1408. <div class="memproto">

  1409.       <table class="memname">

  1410.         <tr>

  1411.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1412.           <td>(</td>

  1413.           <td class="paramtype">Print *&#160;</td>

  1414.           <td class="paramname"><em>pr</em></td><td>)</td>

  1415.           <td></td>

  1416.         </tr>

  1417.       </table>

  1418. </div><div class="memdoc">

  1419. <p>Print error details after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>

  1420. <dl class="params"><dt>Parameters</dt><dd>

  1421.   <table class="params">

  1422.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1423.   </table>

  1424.   </dd>

  1425. </dl>

  1426. 

  1427. </div>

  1428. </div>

  1429. <a class="anchor" id="a296855ca8cc7590b9cbe7b3aeabc8467"></a>

  1430. <div class="memitem">

  1431. <div class="memproto">

  1432. <table class="mlabels">

  1433.   <tr>

  1434.   <td class="mlabels-left">

  1435.       <table class="memname">

  1436.         <tr>

  1437.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1438.           <td>(</td>

  1439.           <td class="paramtype">char const *&#160;</td>

  1440.           <td class="paramname"><em>msg</em></td><td>)</td>

  1441.           <td></td>

  1442.         </tr>

  1443.       </table>

  1444.   </td>

  1445.   <td class="mlabels-right">

  1446. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1447.   </tr>

  1448. </table>

  1449. </div><div class="memdoc">

  1450. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

  1451. <dl class="params"><dt>Parameters</dt><dd>

  1452.   <table class="params">

  1453.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1454.   </table>

  1455.   </dd>

  1456. </dl>

  1457. 

  1458. </div>

  1459. </div>

  1460. <a class="anchor" id="aca07f92b3a06ede0e7a56b68b76dc3b7"></a>

  1461. <div class="memitem">

  1462. <div class="memproto">

  1463.       <table class="memname">

  1464.         <tr>

  1465.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1466.           <td>(</td>

  1467.           <td class="paramtype">Print *&#160;</td>

  1468.           <td class="paramname"><em>pr</em>, </td>

  1469.         </tr>

  1470.         <tr>

  1471.           <td class="paramkey"></td>

  1472.           <td></td>

  1473.           <td class="paramtype">char const *&#160;</td>

  1474.           <td class="paramname"><em>msg</em>&#160;</td>

  1475.         </tr>

  1476.         <tr>

  1477.           <td></td>

  1478.           <td>)</td>

  1479.           <td></td><td></td>

  1480.         </tr>

  1481.       </table>

  1482. </div><div class="memdoc">

  1483. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>

  1484. <dl class="params"><dt>Parameters</dt><dd>

  1485.   <table class="params">

  1486.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1487.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1488.   </table>

  1489.   </dd>

  1490. </dl>

  1491. 

  1492. </div>

  1493. </div>

  1494. <a class="anchor" id="a9c334faf236651db265d5acf65271666"></a>

  1495. <div class="memitem">

  1496. <div class="memproto">

  1497. <table class="mlabels">

  1498.   <tr>

  1499.   <td class="mlabels-left">

  1500.       <table class="memname">

  1501.         <tr>

  1502.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1503.           <td>(</td>

  1504.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1505.           <td class="paramname"><em>msg</em></td><td>)</td>

  1506.           <td></td>

  1507.         </tr>

  1508.       </table>

  1509.   </td>

  1510.   <td class="mlabels-right">

  1511. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  1512.   </tr>

  1513. </table>

  1514. </div><div class="memdoc">

  1515. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::init()</a> fails.</p>

  1516. <dl class="params"><dt>Parameters</dt><dd>

  1517.   <table class="params">

  1518.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1519.   </table>

  1520.   </dd>

  1521. </dl>

  1522. 

  1523. </div>

  1524. </div>

  1525. <a class="anchor" id="ac0b7161c1385841264323ac244f5c89c"></a>

  1526. <div class="memitem">

  1527. <div class="memproto">

  1528.       <table class="memname">

  1529.         <tr>

  1530.           <td class="memname">void SdFatBase::initErrorPrint </td>

  1531.           <td>(</td>

  1532.           <td class="paramtype">Print *&#160;</td>

  1533.           <td class="paramname"><em>pr</em>, </td>

  1534.         </tr>

  1535.         <tr>

  1536.           <td class="paramkey"></td>

  1537.           <td></td>

  1538.           <td class="paramtype">const __FlashStringHelper *&#160;</td>

  1539.           <td class="paramname"><em>msg</em>&#160;</td>

  1540.         </tr>

  1541.         <tr>

  1542.           <td></td>

  1543.           <td>)</td>

  1544.           <td></td><td></td>

  1545.         </tr>

  1546.       </table>

  1547. </div><div class="memdoc">

  1548. <p>Print message and error details and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFatBase::init()</a> fails.</p>

  1549. <dl class="params"><dt>Parameters</dt><dd>

  1550.   <table class="params">

  1551.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print destination. </td></tr>

  1552.     <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Message to print. </td></tr>

  1553.   </table>

  1554.   </dd>

  1555. </dl>

  1556. 

  1557. </div>

  1558. </div>

  1559. <a class="anchor" id="a2398fb37a7a9d5e0dc0ffde6a44a993d"></a>

  1560. <div class="memitem">

  1561. <div class="memproto">

  1562. <table class="mlabels">

  1563.   <tr>

  1564.   <td class="mlabels-left">

  1565.       <table class="memname">

  1566.         <tr>

  1567.           <td class="memname">void FatFileSystem::ls </td>

  1568.           <td>(</td>

  1569.           <td class="paramtype">uint8_t&#160;</td>

  1570.           <td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>

  1571.           <td></td>

  1572.         </tr>

  1573.       </table>

  1574.   </td>

  1575.   <td class="mlabels-right">

  1576. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1577.   </tr>

  1578. </table>

  1579. </div><div class="memdoc">

  1580. <p>List the directory contents of the volume working directory to Serial.</p>

  1581. <dl class="params"><dt>Parameters</dt><dd>

  1582.   <table class="params">

  1583.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  1584.   </table>

  1585.   </dd>

  1586. </dl>

  1587. <p>LS_DATE - Print file modification date</p>

  1588. <p>LS_SIZE - Print file size.</p>

  1589. <p>LS_R - Recursive list of subdirectories. </p>

  1590. 

  1591. </div>

  1592. </div>

  1593. <a class="anchor" id="a122b61dbec5051304bcc81bc08b1b99d"></a>

  1594. <div class="memitem">

  1595. <div class="memproto">

  1596. <table class="mlabels">

  1597.   <tr>

  1598.   <td class="mlabels-left">

  1599.       <table class="memname">

  1600.         <tr>

  1601.           <td class="memname">void FatFileSystem::ls </td>

  1602.           <td>(</td>

  1603.           <td class="paramtype">const char *&#160;</td>

  1604.           <td class="paramname"><em>path</em>, </td>

  1605.         </tr>

  1606.         <tr>

  1607.           <td class="paramkey"></td>

  1608.           <td></td>

  1609.           <td class="paramtype">uint8_t&#160;</td>

  1610.           <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>

  1611.         </tr>

  1612.         <tr>

  1613.           <td></td>

  1614.           <td>)</td>

  1615.           <td></td><td></td>

  1616.         </tr>

  1617.       </table>

  1618.   </td>

  1619.   <td class="mlabels-right">

  1620. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1621.   </tr>

  1622. </table>

  1623. </div><div class="memdoc">

  1624. <p>List the directory contents of a directory to Serial.</p>

  1625. <dl class="params"><dt>Parameters</dt><dd>

  1626.   <table class="params">

  1627.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>

  1628.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  1629.   </table>

  1630.   </dd>

  1631. </dl>

  1632. <p>LS_DATE - Print file modification date</p>

  1633. <p>LS_SIZE - Print file size.</p>

  1634. <p>LS_R - Recursive list of subdirectories. </p>

  1635. 

  1636. </div>

  1637. </div>

  1638. <a class="anchor" id="ad17f2a0925b34cb3807e4c1677a2872f"></a>

  1639. <div class="memitem">

  1640. <div class="memproto">

  1641. <table class="mlabels">

  1642.   <tr>

  1643.   <td class="mlabels-left">

  1644.       <table class="memname">

  1645.         <tr>

  1646.           <td class="memname">void FatFileSystem::ls </td>

  1647.           <td>(</td>

  1648.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1649.           <td class="paramname"><em>pr</em>, </td>

  1650.         </tr>

  1651.         <tr>

  1652.           <td class="paramkey"></td>

  1653.           <td></td>

  1654.           <td class="paramtype">uint8_t&#160;</td>

  1655.           <td class="paramname"><em>flags</em>&#160;</td>

  1656.         </tr>

  1657.         <tr>

  1658.           <td></td>

  1659.           <td>)</td>

  1660.           <td></td><td></td>

  1661.         </tr>

  1662.       </table>

  1663.   </td>

  1664.   <td class="mlabels-right">

  1665. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1666.   </tr>

  1667. </table>

  1668. </div><div class="memdoc">

  1669. <p>List the directory contents of the volume working directory.</p>

  1670. <dl class="params"><dt>Parameters</dt><dd>

  1671.   <table class="params">

  1672.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>

  1673.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  1674.   </table>

  1675.   </dd>

  1676. </dl>

  1677. <p>LS_DATE - Print file modification date</p>

  1678. <p>LS_SIZE - Print file size.</p>

  1679. <p>LS_R - Recursive list of subdirectories. </p>

  1680. 

  1681. </div>

  1682. </div>

  1683. <a class="anchor" id="aa79695db8e910300507210b3067d39fd"></a>

  1684. <div class="memitem">

  1685. <div class="memproto">

  1686. <table class="mlabels">

  1687.   <tr>

  1688.   <td class="mlabels-left">

  1689.       <table class="memname">

  1690.         <tr>

  1691.           <td class="memname">void FatFileSystem::ls </td>

  1692.           <td>(</td>

  1693.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  1694.           <td class="paramname"><em>pr</em>, </td>

  1695.         </tr>

  1696.         <tr>

  1697.           <td class="paramkey"></td>

  1698.           <td></td>

  1699.           <td class="paramtype">const char *&#160;</td>

  1700.           <td class="paramname"><em>path</em>, </td>

  1701.         </tr>

  1702.         <tr>

  1703.           <td class="paramkey"></td>

  1704.           <td></td>

  1705.           <td class="paramtype">uint8_t&#160;</td>

  1706.           <td class="paramname"><em>flags</em>&#160;</td>

  1707.         </tr>

  1708.         <tr>

  1709.           <td></td>

  1710.           <td>)</td>

  1711.           <td></td><td></td>

  1712.         </tr>

  1713.       </table>

  1714.   </td>

  1715.   <td class="mlabels-right">

  1716. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1717.   </tr>

  1718. </table>

  1719. </div><div class="memdoc">

  1720. <p>List the directory contents of a directory.</p>

  1721. <dl class="params"><dt>Parameters</dt><dd>

  1722.   <table class="params">

  1723.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>Print stream for list.</td></tr>

  1724.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>directory to list.</td></tr>

  1725.     <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The inclusive OR of</td></tr>

  1726.   </table>

  1727.   </dd>

  1728. </dl>

  1729. <p>LS_DATE - Print file modification date</p>

  1730. <p>LS_SIZE - Print file size.</p>

  1731. <p>LS_R - Recursive list of subdirectories. </p>

  1732. 

  1733. </div>

  1734. </div>

  1735. <a class="anchor" id="a231c62c98ba8ac3c2624dc5ad2053ebf"></a>

  1736. <div class="memitem">

  1737. <div class="memproto">

  1738. <table class="mlabels">

  1739.   <tr>

  1740.   <td class="mlabels-left">

  1741.       <table class="memname">

  1742.         <tr>

  1743.           <td class="memname">bool FatFileSystem::mkdir </td>

  1744.           <td>(</td>

  1745.           <td class="paramtype">const char *&#160;</td>

  1746.           <td class="paramname"><em>path</em>, </td>

  1747.         </tr>

  1748.         <tr>

  1749.           <td class="paramkey"></td>

  1750.           <td></td>

  1751.           <td class="paramtype">bool&#160;</td>

  1752.           <td class="paramname"><em>pFlag</em> = <code>true</code>&#160;</td>

  1753.         </tr>

  1754.         <tr>

  1755.           <td></td>

  1756.           <td>)</td>

  1757.           <td></td><td></td>

  1758.         </tr>

  1759.       </table>

  1760.   </td>

  1761.   <td class="mlabels-right">

  1762. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1763.   </tr>

  1764. </table>

  1765. </div><div class="memdoc">

  1766. <p>Make a subdirectory in the volume working directory.</p>

  1767. <dl class="params"><dt>Parameters</dt><dd>

  1768.   <table class="params">

  1769.     <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>

  1770.     <tr><td class="paramdir">[in]</td><td class="paramname">pFlag</td><td>Create missing parent directories if true.</td></tr>

  1771.   </table>

  1772.   </dd>

  1773. </dl>

  1774. <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>

  1775. 

  1776. </div>

  1777. </div>

  1778. <a class="anchor" id="a947e4586077a922892b632edac33b67a"></a>

  1779. <div class="memitem">

  1780. <div class="memproto">

  1781. <table class="mlabels">

  1782.   <tr>

  1783.   <td class="mlabels-left">

  1784.       <table class="memname">

  1785.         <tr>

  1786.           <td class="memname"><a class="el" href="class_file.html">File</a> FatFileSystem::open </td>

  1787.           <td>(</td>

  1788.           <td class="paramtype">const char *&#160;</td>

  1789.           <td class="paramname"><em>path</em>, </td>

  1790.         </tr>

  1791.         <tr>

  1792.           <td class="paramkey"></td>

  1793.           <td></td>

  1794.           <td class="paramtype">uint8_t&#160;</td>

  1795.           <td class="paramname"><em>mode</em> = <code><a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a></code>&#160;</td>

  1796.         </tr>

  1797.         <tr>

  1798.           <td></td>

  1799.           <td>)</td>

  1800.           <td></td><td></td>

  1801.         </tr>

  1802.       </table>

  1803.   </td>

  1804.   <td class="mlabels-right">

  1805. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1806.   </tr>

  1807. </table>

  1808. </div><div class="memdoc">

  1809. <p>open a file</p>

  1810. <dl class="params"><dt>Parameters</dt><dd>

  1811.   <table class="params">

  1812.     <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>location of file to be opened. </td></tr>

  1813.     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>open mode flags. </td></tr>

  1814.   </table>

  1815.   </dd>

  1816. </dl>

  1817. <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>

  1818. 

  1819. </div>

  1820. </div>

  1821. <a class="anchor" id="abf7d7d0dab43083d5be10d70ff4669e4"></a>

  1822. <div class="memitem">

  1823. <div class="memproto">

  1824. <table class="mlabels">

  1825.   <tr>

  1826.   <td class="mlabels-left">

  1827.       <table class="memname">

  1828.         <tr>

  1829.           <td class="memname">bool FatFileSystem::remove </td>

  1830.           <td>(</td>

  1831.           <td class="paramtype">const char *&#160;</td>

  1832.           <td class="paramname"><em>path</em></td><td>)</td>

  1833.           <td></td>

  1834.         </tr>

  1835.       </table>

  1836.   </td>

  1837.   <td class="mlabels-right">

  1838. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1839.   </tr>

  1840. </table>

  1841. </div><div class="memdoc">

  1842. <p>Remove a file from the volume working directory.</p>

  1843. <dl class="params"><dt>Parameters</dt><dd>

  1844.   <table class="params">

  1845.     <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>

  1846.   </table>

  1847.   </dd>

  1848. </dl>

  1849. <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>

  1850. 

  1851. </div>

  1852. </div>

  1853. <a class="anchor" id="a0187891a24017b41bd7c5ba63e659e65"></a>

  1854. <div class="memitem">

  1855. <div class="memproto">

  1856. <table class="mlabels">

  1857.   <tr>

  1858.   <td class="mlabels-left">

  1859.       <table class="memname">

  1860.         <tr>

  1861.           <td class="memname">bool FatFileSystem::rename </td>

  1862.           <td>(</td>

  1863.           <td class="paramtype">const char *&#160;</td>

  1864.           <td class="paramname"><em>oldPath</em>, </td>

  1865.         </tr>

  1866.         <tr>

  1867.           <td class="paramkey"></td>

  1868.           <td></td>

  1869.           <td class="paramtype">const char *&#160;</td>

  1870.           <td class="paramname"><em>newPath</em>&#160;</td>

  1871.         </tr>

  1872.         <tr>

  1873.           <td></td>

  1874.           <td>)</td>

  1875.           <td></td><td></td>

  1876.         </tr>

  1877.       </table>

  1878.   </td>

  1879.   <td class="mlabels-right">

  1880. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1881.   </tr>

  1882. </table>

  1883. </div><div class="memdoc">

  1884. <p>Rename a file or subdirectory.</p>

  1885. <dl class="params"><dt>Parameters</dt><dd>

  1886.   <table class="params">

  1887.     <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>

  1888.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>

  1889.   </table>

  1890.   </dd>

  1891. </dl>

  1892. <p>The <em>newPath</em> object must not exist before the rename call.</p>

  1893. <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>

  1894. <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>

  1895. 

  1896. </div>

  1897. </div>

  1898. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>

  1899. <div class="memitem">

  1900. <div class="memproto">

  1901. <table class="mlabels">

  1902.   <tr>

  1903.   <td class="mlabels-left">

  1904.       <table class="memname">

  1905.         <tr>

  1906.           <td class="memname">bool FatFileSystem::rmdir </td>

  1907.           <td>(</td>

  1908.           <td class="paramtype">const char *&#160;</td>

  1909.           <td class="paramname"><em>path</em></td><td>)</td>

  1910.           <td></td>

  1911.         </tr>

  1912.       </table>

  1913.   </td>

  1914.   <td class="mlabels-right">

  1915. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1916.   </tr>

  1917. </table>

  1918. </div><div class="memdoc">

  1919. <p>Remove a subdirectory from the volume's working directory.</p>

  1920. <dl class="params"><dt>Parameters</dt><dd>

  1921.   <table class="params">

  1922.     <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>

  1923.   </table>

  1924.   </dd>

  1925. </dl>

  1926. <p>The subdirectory file will be removed only if it is empty.</p>

  1927. <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>

  1928. 

  1929. </div>

  1930. </div>

  1931. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>

  1932. <div class="memitem">

  1933. <div class="memproto">

  1934. <table class="mlabels">

  1935.   <tr>

  1936.   <td class="mlabels-left">

  1937.       <table class="memname">

  1938.         <tr>

  1939.           <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>

  1940.           <td>(</td>

  1941.           <td class="paramname"></td><td>)</td>

  1942.           <td> const</td>

  1943.         </tr>

  1944.       </table>

  1945.   </td>

  1946.   <td class="mlabels-right">

  1947. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1948.   </tr>

  1949. </table>

  1950. </div><div class="memdoc">

  1951. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>

  1952. 

  1953. </div>

  1954. </div>

  1955. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>

  1956. <div class="memitem">

  1957. <div class="memproto">

  1958. <table class="mlabels">

  1959.   <tr>

  1960.   <td class="mlabels-left">

  1961.       <table class="memname">

  1962.         <tr>

  1963.           <td class="memname">uint32_t FatVolume::rootDirStart </td>

  1964.           <td>(</td>

  1965.           <td class="paramname"></td><td>)</td>

  1966.           <td> const</td>

  1967.         </tr>

  1968.       </table>

  1969.   </td>

  1970.   <td class="mlabels-right">

  1971. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  1972.   </tr>

  1973. </table>

  1974. </div><div class="memdoc">

  1975. <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>

  1976. 

  1977. </div>

  1978. </div>

  1979. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>

  1980. <div class="memitem">

  1981. <div class="memproto">

  1982. <table class="mlabels">

  1983.   <tr>

  1984.   <td class="mlabels-left">

  1985.       <table class="memname">

  1986.         <tr>

  1987.           <td class="memname">bool FatFileSystem::truncate </td>

  1988.           <td>(</td>

  1989.           <td class="paramtype">const char *&#160;</td>

  1990.           <td class="paramname"><em>path</em>, </td>

  1991.         </tr>

  1992.         <tr>

  1993.           <td class="paramkey"></td>

  1994.           <td></td>

  1995.           <td class="paramtype">uint32_t&#160;</td>

  1996.           <td class="paramname"><em>length</em>&#160;</td>

  1997.         </tr>

  1998.         <tr>

  1999.           <td></td>

  2000.           <td>)</td>

  2001.           <td></td><td></td>

  2002.         </tr>

  2003.       </table>

  2004.   </td>

  2005.   <td class="mlabels-right">

  2006. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2007.   </tr>

  2008. </table>

  2009. </div><div class="memdoc">

  2010. <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>

  2011. <dl class="params"><dt>Parameters</dt><dd>

  2012.   <table class="params">

  2013.     <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>

  2014.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2015.   </table>

  2016.   </dd>

  2017. </dl>

  2018. <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>

  2019. 

  2020. </div>

  2021. </div>

  2022. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>

  2023. <div class="memitem">

  2024. <div class="memproto">

  2025. <table class="mlabels">

  2026.   <tr>

  2027.   <td class="mlabels-left">

  2028.       <table class="memname">

  2029.         <tr>

  2030.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>

  2031.           <td>(</td>

  2032.           <td class="paramname"></td><td>)</td>

  2033.           <td></td>

  2034.         </tr>

  2035.       </table>

  2036.   </td>

  2037.   <td class="mlabels-right">

  2038. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2039.   </tr>

  2040. </table>

  2041. </div><div class="memdoc">

  2042. <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>

  2043. 

  2044. </div>

  2045. </div>

  2046. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>

  2047. <div class="memitem">

  2048. <div class="memproto">

  2049. <table class="mlabels">

  2050.   <tr>

  2051.   <td class="mlabels-left">

  2052.       <table class="memname">

  2053.         <tr>

  2054.           <td class="memname">uint32_t FatVolume::volumeBlockCount </td>

  2055.           <td>(</td>

  2056.           <td class="paramname"></td><td>)</td>

  2057.           <td> const</td>

  2058.         </tr>

  2059.       </table>

  2060.   </td>

  2061.   <td class="mlabels-right">

  2062. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2063.   </tr>

  2064. </table>

  2065. </div><div class="memdoc">

  2066. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>

  2067. 

  2068. </div>

  2069. </div>

  2070. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>

  2071. <div class="memitem">

  2072. <div class="memproto">

  2073. <table class="mlabels">

  2074.   <tr>

  2075.   <td class="mlabels-left">

  2076.       <table class="memname">

  2077.         <tr>

  2078.           <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>

  2079.           <td>(</td>

  2080.           <td class="paramname"></td><td>)</td>

  2081.           <td></td>

  2082.         </tr>

  2083.       </table>

  2084.   </td>

  2085.   <td class="mlabels-right">

  2086. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2087.   </tr>

  2088. </table>

  2089. </div><div class="memdoc">

  2090. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>

  2091. 

  2092. </div>

  2093. </div>

  2094. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></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::wipe </td>

  2103.           <td>(</td>

  2104.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2105.           <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>

  2106.           <td></td>

  2107.         </tr>

  2108.       </table>

  2109.   </td>

  2110.   <td class="mlabels-right">

  2111. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2112.   </tr>

  2113. </table>

  2114. </div><div class="memdoc">

  2115. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>

  2116.   <table class="params">

  2117.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>

  2118.   </table>

  2119.   </dd>

  2120. </dl>

  2121. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2122. 

  2123. </div>

  2124. </div>

  2125. <hr/>The documentation for this class was generated from the following files:<ul>

  2126. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  2127. <li>Arduino/libraries/SdFat/src/SdFat.cpp</li>

  2128. </ul>

  2129. </div><!-- contents -->

  2130. <!-- start footer part -->

  2131. <hr class="footer"/><address class="footer"><small>

  2132. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2133. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2134. </a> 1.8.10

  2135. </small></address>

  2136. </body>

  2137. </html>