visus
/
teensy-sdfat
Suivre 1
Ajouter aux favoris 0
Bifurcation 0
Code Tickets 0 Demandes d'ajout 0 Versions 0 Wiki Activité
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
26 Révisions
1 Branche
Aborescence: 6ac05353a6
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '6ac05353a6'
${ noResults }
teensy-sdfat/html/class_sd_fat.html

2321 lines
96KB
Brut Annotations Historique 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

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

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

  41.       <li><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-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

  93. <p>Main file system class for SdFat library.  

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for SdFat:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node2" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="15,155,102,181"/>

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

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

  105. </map>

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

  107. <div class="dynheader">

  108. Collaboration diagram for SdFat:</div>

  109. <div class="dyncontent">

  110. <div class="center"><img src="class_sd_fat__coll__graph.png" border="0" usemap="#_sd_fat_coll__map" alt="Collaboration graph"/></div>

  111. <map name="_sd_fat_coll__map" id="_sd_fat_coll__map">

  112. <area shape="rect" id="node2" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="15,155,102,181"/>

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

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

  115. </map>

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

  117. <table class="memberdecls">

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

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

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

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

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

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

  124. <tr class="memitem:a9552f4c1811a1d3c00e183cf12afd45d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a9552f4c1811a1d3c00e183cf12afd45d">begin</a> (uint8_t csPin=SS, uint8_t divisor=2)</td></tr>

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

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

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

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

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

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

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

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

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

  134. <tr class="memitem:ae60c555879572052295b55fe2886d43a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#ae60c555879572052295b55fe2886d43a">cardBegin</a> (uint8_t csPin=SS, uint8_t divisor=2)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  246. </table>

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

  248. <div class="textblock"><p>Main file system class for SdFat library. </p>

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

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

  251. <div class="memitem">

  252. <div class="memproto">

  253. <table class="mlabels">

  254.   <tr>

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

  256.       <table class="memname">

  257.         <tr>

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

  259.           <td>(</td>

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

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

  262.           <td></td>

  263.         </tr>

  264.       </table>

  265.   </td>

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

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

  268.   </tr>

  269. </table>

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

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

  272.   <table class="params">

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

  274.   </table>

  275.   </dd>

  276. </dl>

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

  278. 

  279. </div>

  280. </div>

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

  282. <div class="memitem">

  283. <div class="memproto">

  284. <table class="mlabels">

  285.   <tr>

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

  287.       <table class="memname">

  288.         <tr>

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

  290.           <td>(</td>

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

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

  293.         </tr>

  294.         <tr>

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

  296.           <td></td>

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

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

  299.         </tr>

  300.         <tr>

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

  302.           <td></td>

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

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

  305.         </tr>

  306.         <tr>

  307.           <td></td>

  308.           <td>)</td>

  309.           <td></td><td></td>

  310.         </tr>

  311.       </table>

  312.   </td>

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

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

  315.   </tr>

  316. </table>

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

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

  319.   <table class="params">

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

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

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

  323.   </table>

  324.   </dd>

  325. </dl>

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

  327. 

  328. </div>

  329. </div>

  330. <a class="anchor" id="a9552f4c1811a1d3c00e183cf12afd45d"></a>

  331. <div class="memitem">

  332. <div class="memproto">

  333. <table class="mlabels">

  334.   <tr>

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

  336.       <table class="memname">

  337.         <tr>

  338.           <td class="memname">bool SdFat::begin </td>

  339.           <td>(</td>

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

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

  342.         </tr>

  343.         <tr>

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

  345.           <td></td>

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

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

  348.         </tr>

  349.         <tr>

  350.           <td></td>

  351.           <td>)</td>

  352.           <td></td><td></td>

  353.         </tr>

  354.       </table>

  355.   </td>

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

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

  358.   </tr>

  359. </table>

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

  361. <p>Initialize SD card and file system.</p>

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

  363.   <table class="params">

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

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

  366.   </table>

  367.   </dd>

  368. </dl>

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

  370. 

  371. </div>

  372. </div>

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

  374. <div class="memitem">

  375. <div class="memproto">

  376. <table class="mlabels">

  377.   <tr>

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

  379.       <table class="memname">

  380.         <tr>

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

  382.           <td>(</td>

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

  384.           <td> const</td>

  385.         </tr>

  386.       </table>

  387.   </td>

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

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

  390.   </tr>

  391. </table>

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

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

  394. 

  395. </div>

  396. </div>

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

  398. <div class="memitem">

  399. <div class="memproto">

  400. <table class="mlabels">

  401.   <tr>

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

  403.       <table class="memname">

  404.         <tr>

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

  406.           <td>(</td>

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

  408.           <td> const</td>

  409.         </tr>

  410.       </table>

  411.   </td>

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

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

  414.   </tr>

  415. </table>

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

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

  418. 

  419. </div>

  420. </div>

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

  422. <div class="memitem">

  423. <div class="memproto">

  424. <table class="mlabels">

  425.   <tr>

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

  427.       <table class="memname">

  428.         <tr>

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

  430.           <td>(</td>

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

  432.           <td></td>

  433.         </tr>

  434.       </table>

  435.   </td>

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

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

  438.   </tr>

  439. </table>

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

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

  442. 

  443. </div>

  444. </div>

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

  446. <div class="memitem">

  447. <div class="memproto">

  448. <table class="mlabels">

  449.   <tr>

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

  451.       <table class="memname">

  452.         <tr>

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

  454.           <td>(</td>

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

  456.           <td></td>

  457.         </tr>

  458.       </table>

  459.   </td>

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

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

  462.   </tr>

  463. </table>

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

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

  466. 

  467. </div>

  468. </div>

  469. <a class="anchor" id="ae60c555879572052295b55fe2886d43a"></a>

  470. <div class="memitem">

  471. <div class="memproto">

  472. <table class="mlabels">

  473.   <tr>

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

  475.       <table class="memname">

  476.         <tr>

  477.           <td class="memname">bool SdFat::cardBegin </td>

  478.           <td>(</td>

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

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

  481.         </tr>

  482.         <tr>

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

  484.           <td></td>

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

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

  487.         </tr>

  488.         <tr>

  489.           <td></td>

  490.           <td>)</td>

  491.           <td></td><td></td>

  492.         </tr>

  493.       </table>

  494.   </td>

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

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

  497.   </tr>

  498. </table>

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

  500. <p>Diagnostic call to initialize SD card - use for diagnostic purposes only. </p><dl class="params"><dt>Parameters</dt><dd>

  501.   <table class="params">

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

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

  504.   </table>

  505.   </dd>

  506. </dl>

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

  508. 

  509. </div>

  510. </div>

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

  512. <div class="memitem">

  513. <div class="memproto">

  514. <table class="mlabels">

  515.   <tr>

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

  517.       <table class="memname">

  518.         <tr>

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

  520.           <td>(</td>

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

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

  523.           <td></td>

  524.         </tr>

  525.       </table>

  526.   </td>

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

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

  529.   </tr>

  530. </table>

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

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

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

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

  535.   <table class="params">

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

  537.   </table>

  538.   </dd>

  539. </dl>

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

  541. 

  542. </div>

  543. </div>

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

  545. <div class="memitem">

  546. <div class="memproto">

  547. <table class="mlabels">

  548.   <tr>

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

  550.       <table class="memname">

  551.         <tr>

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

  553.           <td>(</td>

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

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

  556.         </tr>

  557.         <tr>

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

  559.           <td></td>

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

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

  562.         </tr>

  563.         <tr>

  564.           <td></td>

  565.           <td>)</td>

  566.           <td></td><td></td>

  567.         </tr>

  568.       </table>

  569.   </td>

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

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

  572.   </tr>

  573. </table>

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

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

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

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

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

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

  580.   <table class="params">

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

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

  583.   </table>

  584.   </dd>

  585. </dl>

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

  587. 

  588. </div>

  589. </div>

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

  591. <div class="memitem">

  592. <div class="memproto">

  593. <table class="mlabels">

  594.   <tr>

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

  596.       <table class="memname">

  597.         <tr>

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

  599.           <td>(</td>

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

  601.           <td></td>

  602.         </tr>

  603.       </table>

  604.   </td>

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

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

  607.   </tr>

  608. </table>

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

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

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

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

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

  614. 

  615. </div>

  616. </div>

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

  618. <div class="memitem">

  619. <div class="memproto">

  620. <table class="mlabels">

  621.   <tr>

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

  623.       <table class="memname">

  624.         <tr>

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

  626.           <td>(</td>

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

  628.           <td> const</td>

  629.         </tr>

  630.       </table>

  631.   </td>

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

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

  634.   </tr>

  635. </table>

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

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

  638. 

  639. </div>

  640. </div>

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

  642. <div class="memitem">

  643. <div class="memproto">

  644. <table class="mlabels">

  645.   <tr>

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

  647.       <table class="memname">

  648.         <tr>

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

  650.           <td>(</td>

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

  652.           <td> const</td>

  653.         </tr>

  654.       </table>

  655.   </td>

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

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

  658.   </tr>

  659. </table>

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

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

  662. 

  663. </div>

  664. </div>

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

  666. <div class="memitem">

  667. <div class="memproto">

  668. <table class="mlabels">

  669.   <tr>

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

  671.       <table class="memname">

  672.         <tr>

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

  674.           <td>(</td>

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

  676.           <td> const</td>

  677.         </tr>

  678.       </table>

  679.   </td>

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

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

  682.   </tr>

  683. </table>

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

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

  686. 

  687. </div>

  688. </div>

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

  690. <div class="memitem">

  691. <div class="memproto">

  692. <table class="mlabels">

  693.   <tr>

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

  695.       <table class="memname">

  696.         <tr>

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

  698.           <td>(</td>

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

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

  701.         </tr>

  702.         <tr>

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

  704.           <td></td>

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

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

  707.         </tr>

  708.         <tr>

  709.           <td></td>

  710.           <td>)</td>

  711.           <td></td><td></td>

  712.         </tr>

  713.       </table>

  714.   </td>

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

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

  717.   </tr>

  718. </table>

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

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

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

  722.   <table class="params">

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

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

  725.   </table>

  726.   </dd>

  727. </dl>

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

  729. 

  730. </div>

  731. </div>

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

  733. <div class="memitem">

  734. <div class="memproto">

  735. <table class="mlabels">

  736.   <tr>

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

  738.       <table class="memname">

  739.         <tr>

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

  741.           <td>(</td>

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

  743.           <td></td>

  744.         </tr>

  745.       </table>

  746.   </td>

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

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

  749.   </tr>

  750. </table>

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

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

  753. 

  754. </div>

  755. </div>

  756. <a class="anchor" id="ae8cf95abf0ffb1c7a55eb1a192c28982"></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">Print *&#160;</td>

  767.           <td class="paramname"><em>pr</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">inherited</span></span>  </td>

  774.   </tr>

  775. </table>

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

  777. <p>Print 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">pr</td><td>Print destination. </td></tr>

  781.   </table>

  782.   </dd>

  783. </dl>

  784. 

  785. </div>

  786. </div>

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

  788. <div class="memitem">

  789. <div class="memproto">

  790. <table class="mlabels">

  791.   <tr>

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

  793.       <table class="memname">

  794.         <tr>

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

  796.           <td>(</td>

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

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

  799.           <td></td>

  800.         </tr>

  801.       </table>

  802.   </td>

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

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

  805.   </tr>

  806. </table>

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

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

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

  810.   <table class="params">

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

  812.   </table>

  813.   </dd>

  814. </dl>

  815. 

  816. </div>

  817. </div>

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

  819. <div class="memitem">

  820. <div class="memproto">

  821. <table class="mlabels">

  822.   <tr>

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

  824.       <table class="memname">

  825.         <tr>

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

  827.           <td>(</td>

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

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

  830.         </tr>

  831.         <tr>

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

  833.           <td></td>

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

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

  836.         </tr>

  837.         <tr>

  838.           <td></td>

  839.           <td>)</td>

  840.           <td></td><td></td>

  841.         </tr>

  842.       </table>

  843.   </td>

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

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

  846.   </tr>

  847. </table>

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

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

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

  851.   <table class="params">

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

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

  854.   </table>

  855.   </dd>

  856. </dl>

  857. 

  858. </div>

  859. </div>

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

  861. <div class="memitem">

  862. <div class="memproto">

  863. <table class="mlabels">

  864.   <tr>

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

  866.       <table class="memname">

  867.         <tr>

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

  869.           <td>(</td>

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

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

  872.           <td></td>

  873.         </tr>

  874.       </table>

  875.   </td>

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

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

  878.   </tr>

  879. </table>

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

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

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

  883.   <table class="params">

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

  885.   </table>

  886.   </dd>

  887. </dl>

  888. 

  889. </div>

  890. </div>

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

  892. <div class="memitem">

  893. <div class="memproto">

  894. <table class="mlabels">

  895.   <tr>

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

  897.       <table class="memname">

  898.         <tr>

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

  900.           <td>(</td>

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

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

  903.         </tr>

  904.         <tr>

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

  906.           <td></td>

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

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

  909.         </tr>

  910.         <tr>

  911.           <td></td>

  912.           <td>)</td>

  913.           <td></td><td></td>

  914.         </tr>

  915.       </table>

  916.   </td>

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

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

  919.   </tr>

  920. </table>

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

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

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

  924.   <table class="params">

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

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

  927.   </table>

  928.   </dd>

  929. </dl>

  930. 

  931. </div>

  932. </div>

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

  934. <div class="memitem">

  935. <div class="memproto">

  936. <table class="mlabels">

  937.   <tr>

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

  939.       <table class="memname">

  940.         <tr>

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

  942.           <td>(</td>

  943.           <td class="paramname"></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 class="mlabel">inherited</span></span>  </td>

  950.   </tr>

  951. </table>

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

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

  954. 

  955. </div>

  956. </div>

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

  958. <div class="memitem">

  959. <div class="memproto">

  960. <table class="mlabels">

  961.   <tr>

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

  963.       <table class="memname">

  964.         <tr>

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

  966.           <td>(</td>

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

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

  969.           <td></td>

  970.         </tr>

  971.       </table>

  972.   </td>

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

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

  975.   </tr>

  976. </table>

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

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

  979.   <table class="params">

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

  981.   </table>

  982.   </dd>

  983. </dl>

  984. 

  985. </div>

  986. </div>

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

  988. <div class="memitem">

  989. <div class="memproto">

  990. <table class="mlabels">

  991.   <tr>

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

  993.       <table class="memname">

  994.         <tr>

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

  996.           <td>(</td>

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

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

  999.           <td></td>

  1000.         </tr>

  1001.       </table>

  1002.   </td>

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

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

  1005.   </tr>

  1006. </table>

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

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

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

  1010.   <table class="params">

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

  1012.   </table>

  1013.   </dd>

  1014. </dl>

  1015. 

  1016. </div>

  1017. </div>

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

  1019. <div class="memitem">

  1020. <div class="memproto">

  1021. <table class="mlabels">

  1022.   <tr>

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

  1024.       <table class="memname">

  1025.         <tr>

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

  1027.           <td>(</td>

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

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

  1030.         </tr>

  1031.         <tr>

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

  1033.           <td></td>

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

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

  1036.         </tr>

  1037.         <tr>

  1038.           <td></td>

  1039.           <td>)</td>

  1040.           <td></td><td></td>

  1041.         </tr>

  1042.       </table>

  1043.   </td>

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

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

  1046.   </tr>

  1047. </table>

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

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

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

  1051.   <table class="params">

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

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

  1054.   </table>

  1055.   </dd>

  1056. </dl>

  1057. 

  1058. </div>

  1059. </div>

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

  1061. <div class="memitem">

  1062. <div class="memproto">

  1063. <table class="mlabels">

  1064.   <tr>

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

  1066.       <table class="memname">

  1067.         <tr>

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

  1069.           <td>(</td>

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

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

  1072.           <td></td>

  1073.         </tr>

  1074.       </table>

  1075.   </td>

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

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

  1078.   </tr>

  1079. </table>

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

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

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

  1083.   <table class="params">

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

  1085.   </table>

  1086.   </dd>

  1087. </dl>

  1088. 

  1089. </div>

  1090. </div>

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

  1092. <div class="memitem">

  1093. <div class="memproto">

  1094. <table class="mlabels">

  1095.   <tr>

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

  1097.       <table class="memname">

  1098.         <tr>

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

  1100.           <td>(</td>

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

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

  1103.         </tr>

  1104.         <tr>

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

  1106.           <td></td>

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

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

  1109.         </tr>

  1110.         <tr>

  1111.           <td></td>

  1112.           <td>)</td>

  1113.           <td></td><td></td>

  1114.         </tr>

  1115.       </table>

  1116.   </td>

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

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

  1119.   </tr>

  1120. </table>

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

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

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

  1124.   <table class="params">

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

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

  1127.   </table>

  1128.   </dd>

  1129. </dl>

  1130. 

  1131. </div>

  1132. </div>

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

  1134. <div class="memitem">

  1135. <div class="memproto">

  1136. <table class="mlabels">

  1137.   <tr>

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

  1139.       <table class="memname">

  1140.         <tr>

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

  1142.           <td>(</td>

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

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

  1145.           <td></td>

  1146.         </tr>

  1147.       </table>

  1148.   </td>

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

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

  1151.   </tr>

  1152. </table>

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

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

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

  1156.   <table class="params">

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

  1158.   </table>

  1159.   </dd>

  1160. </dl>

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

  1162. 

  1163. </div>

  1164. </div>

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

  1166. <div class="memitem">

  1167. <div class="memproto">

  1168. <table class="mlabels">

  1169.   <tr>

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

  1171.       <table class="memname">

  1172.         <tr>

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

  1174.           <td>(</td>

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

  1176.           <td></td>

  1177.         </tr>

  1178.       </table>

  1179.   </td>

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

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

  1182.   </tr>

  1183. </table>

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

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

  1186. 

  1187. </div>

  1188. </div>

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

  1190. <div class="memitem">

  1191. <div class="memproto">

  1192. <table class="mlabels">

  1193.   <tr>

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

  1195.       <table class="memname">

  1196.         <tr>

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

  1198.           <td>(</td>

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

  1200.           <td> const</td>

  1201.         </tr>

  1202.       </table>

  1203.   </td>

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

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

  1206.   </tr>

  1207. </table>

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

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

  1210. 

  1211. </div>

  1212. </div>

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

  1214. <div class="memitem">

  1215. <div class="memproto">

  1216. <table class="mlabels">

  1217.   <tr>

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

  1219.       <table class="memname">

  1220.         <tr>

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

  1222.           <td>(</td>

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

  1224.           <td> const</td>

  1225.         </tr>

  1226.       </table>

  1227.   </td>

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

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

  1230.   </tr>

  1231. </table>

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

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

  1234. 

  1235. </div>

  1236. </div>

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

  1238. <div class="memitem">

  1239. <div class="memproto">

  1240. <table class="mlabels">

  1241.   <tr>

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

  1243.       <table class="memname">

  1244.         <tr>

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

  1246.           <td>(</td>

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

  1248.           <td></td>

  1249.         </tr>

  1250.       </table>

  1251.   </td>

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

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

  1254.   </tr>

  1255. </table>

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

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

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

  1259. 

  1260. </div>

  1261. </div>

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

  1263. <div class="memitem">

  1264. <div class="memproto">

  1265. <table class="mlabels">

  1266.   <tr>

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

  1268.       <table class="memname">

  1269.         <tr>

  1270.           <td class="memname">bool SdFatBase::fsBegin </td>

  1271.           <td>(</td>

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

  1273.           <td></td>

  1274.         </tr>

  1275.       </table>

  1276.   </td>

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

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

  1279.   </tr>

  1280. </table>

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

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

  1283. 

  1284. </div>

  1285. </div>

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

  1287. <div class="memitem">

  1288. <div class="memproto">

  1289. <table class="mlabels">

  1290.   <tr>

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

  1292.       <table class="memname">

  1293.         <tr>

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

  1295.           <td>(</td>

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

  1297.           <td></td>

  1298.         </tr>

  1299.       </table>

  1300.   </td>

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

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

  1303.   </tr>

  1304. </table>

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

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

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

  1308. 

  1309. </div>

  1310. </div>

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

  1312. <div class="memitem">

  1313. <div class="memproto">

  1314. <table class="mlabels">

  1315.   <tr>

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

  1317.       <table class="memname">

  1318.         <tr>

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

  1320.           <td>(</td>

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

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

  1323.           <td></td>

  1324.         </tr>

  1325.       </table>

  1326.   </td>

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

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

  1329.   </tr>

  1330. </table>

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

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

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

  1334.   <table class="params">

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

  1336.   </table>

  1337.   </dd>

  1338. </dl>

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

  1340. 

  1341. </div>

  1342. </div>

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

  1344. <div class="memitem">

  1345. <div class="memproto">

  1346. <table class="mlabels">

  1347.   <tr>

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

  1349.       <table class="memname">

  1350.         <tr>

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

  1352.           <td>(</td>

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

  1354.           <td></td>

  1355.         </tr>

  1356.       </table>

  1357.   </td>

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

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

  1360.   </tr>

  1361. </table>

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

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

  1364. 

  1365. </div>

  1366. </div>

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

  1368. <div class="memitem">

  1369. <div class="memproto">

  1370. <table class="mlabels">

  1371.   <tr>

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

  1373.       <table class="memname">

  1374.         <tr>

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

  1376.           <td>(</td>

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

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

  1379.           <td></td>

  1380.         </tr>

  1381.       </table>

  1382.   </td>

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

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

  1385.   </tr>

  1386. </table>

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

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

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

  1390.   <table class="params">

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

  1392.   </table>

  1393.   </dd>

  1394. </dl>

  1395. 

  1396. </div>

  1397. </div>

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

  1399. <div class="memitem">

  1400. <div class="memproto">

  1401. <table class="mlabels">

  1402.   <tr>

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

  1404.       <table class="memname">

  1405.         <tr>

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

  1407.           <td>(</td>

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

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

  1410.           <td></td>

  1411.         </tr>

  1412.       </table>

  1413.   </td>

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

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

  1416.   </tr>

  1417. </table>

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

  1419. <p>Print message, error details, and halt after <a class="el" href="class_fat_volume.html#acab819fa25a91dad1cc698a7e1e0eb32">SdFat::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">msg</td><td>Message to print. </td></tr>

  1423.   </table>

  1424.   </dd>

  1425. </dl>

  1426. 

  1427. </div>

  1428. </div>

  1429. <a class="anchor" id="a02f18794078b7a1c9662c3ded438cff4"></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::initErrorHalt </td>

  1438.           <td>(</td>

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

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

  1441.         </tr>

  1442.         <tr>

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

  1444.           <td></td>

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

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

  1447.         </tr>

  1448.         <tr>

  1449.           <td></td>

  1450.           <td>)</td>

  1451.           <td></td><td></td>

  1452.         </tr>

  1453.       </table>

  1454.   </td>

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

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

  1457.   </tr>

  1458. </table>

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

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

  1461.   <table class="params">

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

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

  1464.   </table>

  1465.   </dd>

  1466. </dl>

  1467. 

  1468. </div>

  1469. </div>

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

  1471. <div class="memitem">

  1472. <div class="memproto">

  1473. <table class="mlabels">

  1474.   <tr>

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

  1476.       <table class="memname">

  1477.         <tr>

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

  1479.           <td>(</td>

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

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

  1482.           <td></td>

  1483.         </tr>

  1484.       </table>

  1485.   </td>

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

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

  1488.   </tr>

  1489. </table>

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

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

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

  1493.   <table class="params">

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

  1495.   </table>

  1496.   </dd>

  1497. </dl>

  1498. 

  1499. </div>

  1500. </div>

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

  1502. <div class="memitem">

  1503. <div class="memproto">

  1504. <table class="mlabels">

  1505.   <tr>

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

  1507.       <table class="memname">

  1508.         <tr>

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

  1510.           <td>(</td>

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

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

  1513.         </tr>

  1514.         <tr>

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

  1516.           <td></td>

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

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

  1519.         </tr>

  1520.         <tr>

  1521.           <td></td>

  1522.           <td>)</td>

  1523.           <td></td><td></td>

  1524.         </tr>

  1525.       </table>

  1526.   </td>

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

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

  1529.   </tr>

  1530. </table>

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

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

  1533.   <table class="params">

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

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

  1536.   </table>

  1537.   </dd>

  1538. </dl>

  1539. 

  1540. </div>

  1541. </div>

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

  1543. <div class="memitem">

  1544. <div class="memproto">

  1545. <table class="mlabels">

  1546.   <tr>

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

  1548.       <table class="memname">

  1549.         <tr>

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

  1551.           <td>(</td>

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

  1553.           <td></td>

  1554.         </tr>

  1555.       </table>

  1556.   </td>

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

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

  1559.   </tr>

  1560. </table>

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

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

  1563. 

  1564. </div>

  1565. </div>

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

  1567. <div class="memitem">

  1568. <div class="memproto">

  1569. <table class="mlabels">

  1570.   <tr>

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

  1572.       <table class="memname">

  1573.         <tr>

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

  1575.           <td>(</td>

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

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

  1578.           <td></td>

  1579.         </tr>

  1580.       </table>

  1581.   </td>

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

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

  1584.   </tr>

  1585. </table>

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

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

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

  1589.   <table class="params">

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

  1591.   </table>

  1592.   </dd>

  1593. </dl>

  1594. 

  1595. </div>

  1596. </div>

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

  1598. <div class="memitem">

  1599. <div class="memproto">

  1600. <table class="mlabels">

  1601.   <tr>

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

  1603.       <table class="memname">

  1604.         <tr>

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

  1606.           <td>(</td>

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

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

  1609.           <td></td>

  1610.         </tr>

  1611.       </table>

  1612.   </td>

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

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

  1615.   </tr>

  1616. </table>

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

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

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

  1620.   <table class="params">

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

  1622.   </table>

  1623.   </dd>

  1624. </dl>

  1625. 

  1626. </div>

  1627. </div>

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

  1629. <div class="memitem">

  1630. <div class="memproto">

  1631. <table class="mlabels">

  1632.   <tr>

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

  1634.       <table class="memname">

  1635.         <tr>

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

  1637.           <td>(</td>

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

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

  1640.         </tr>

  1641.         <tr>

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

  1643.           <td></td>

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

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

  1646.         </tr>

  1647.         <tr>

  1648.           <td></td>

  1649.           <td>)</td>

  1650.           <td></td><td></td>

  1651.         </tr>

  1652.       </table>

  1653.   </td>

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

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

  1656.   </tr>

  1657. </table>

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

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

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

  1661.   <table class="params">

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

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

  1664.   </table>

  1665.   </dd>

  1666. </dl>

  1667. 

  1668. </div>

  1669. </div>

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

  1671. <div class="memitem">

  1672. <div class="memproto">

  1673. <table class="mlabels">

  1674.   <tr>

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

  1676.       <table class="memname">

  1677.         <tr>

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

  1679.           <td>(</td>

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

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

  1682.           <td></td>

  1683.         </tr>

  1684.       </table>

  1685.   </td>

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

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

  1688.   </tr>

  1689. </table>

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

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

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

  1693.   <table class="params">

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

  1695.   </table>

  1696.   </dd>

  1697. </dl>

  1698. 

  1699. </div>

  1700. </div>

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

  1702. <div class="memitem">

  1703. <div class="memproto">

  1704. <table class="mlabels">

  1705.   <tr>

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

  1707.       <table class="memname">

  1708.         <tr>

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

  1710.           <td>(</td>

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

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

  1713.         </tr>

  1714.         <tr>

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

  1716.           <td></td>

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

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

  1719.         </tr>

  1720.         <tr>

  1721.           <td></td>

  1722.           <td>)</td>

  1723.           <td></td><td></td>

  1724.         </tr>

  1725.       </table>

  1726.   </td>

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

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

  1729.   </tr>

  1730. </table>

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

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

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

  1734.   <table class="params">

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

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

  1737.   </table>

  1738.   </dd>

  1739. </dl>

  1740. 

  1741. </div>

  1742. </div>

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

  1744. <div class="memitem">

  1745. <div class="memproto">

  1746. <table class="mlabels">

  1747.   <tr>

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

  1749.       <table class="memname">

  1750.         <tr>

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

  1752.           <td>(</td>

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

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

  1755.           <td></td>

  1756.         </tr>

  1757.       </table>

  1758.   </td>

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

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

  1761.   </tr>

  1762. </table>

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

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

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

  1766.   <table class="params">

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

  1768.   </table>

  1769.   </dd>

  1770. </dl>

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

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

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

  1774. 

  1775. </div>

  1776. </div>

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

  1778. <div class="memitem">

  1779. <div class="memproto">

  1780. <table class="mlabels">

  1781.   <tr>

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

  1783.       <table class="memname">

  1784.         <tr>

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

  1786.           <td>(</td>

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

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

  1789.         </tr>

  1790.         <tr>

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

  1792.           <td></td>

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

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

  1795.         </tr>

  1796.         <tr>

  1797.           <td></td>

  1798.           <td>)</td>

  1799.           <td></td><td></td>

  1800.         </tr>

  1801.       </table>

  1802.   </td>

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

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

  1805.   </tr>

  1806. </table>

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

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

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

  1810.   <table class="params">

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

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

  1813.   </table>

  1814.   </dd>

  1815. </dl>

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

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

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

  1819. 

  1820. </div>

  1821. </div>

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

  1823. <div class="memitem">

  1824. <div class="memproto">

  1825. <table class="mlabels">

  1826.   <tr>

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

  1828.       <table class="memname">

  1829.         <tr>

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

  1831.           <td>(</td>

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

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

  1834.         </tr>

  1835.         <tr>

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

  1837.           <td></td>

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

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

  1840.         </tr>

  1841.         <tr>

  1842.           <td></td>

  1843.           <td>)</td>

  1844.           <td></td><td></td>

  1845.         </tr>

  1846.       </table>

  1847.   </td>

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

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

  1850.   </tr>

  1851. </table>

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

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

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

  1855.   <table class="params">

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

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

  1858.   </table>

  1859.   </dd>

  1860. </dl>

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

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

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

  1864. 

  1865. </div>

  1866. </div>

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

  1868. <div class="memitem">

  1869. <div class="memproto">

  1870. <table class="mlabels">

  1871.   <tr>

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

  1873.       <table class="memname">

  1874.         <tr>

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

  1876.           <td>(</td>

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

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

  1879.         </tr>

  1880.         <tr>

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

  1882.           <td></td>

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

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

  1885.         </tr>

  1886.         <tr>

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

  1888.           <td></td>

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

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

  1891.         </tr>

  1892.         <tr>

  1893.           <td></td>

  1894.           <td>)</td>

  1895.           <td></td><td></td>

  1896.         </tr>

  1897.       </table>

  1898.   </td>

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

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

  1901.   </tr>

  1902. </table>

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

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

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

  1906.   <table class="params">

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

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

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

  1910.   </table>

  1911.   </dd>

  1912. </dl>

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

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

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

  1916. 

  1917. </div>

  1918. </div>

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

  1920. <div class="memitem">

  1921. <div class="memproto">

  1922. <table class="mlabels">

  1923.   <tr>

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

  1925.       <table class="memname">

  1926.         <tr>

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

  1928.           <td>(</td>

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

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

  1931.         </tr>

  1932.         <tr>

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

  1934.           <td></td>

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

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

  1937.         </tr>

  1938.         <tr>

  1939.           <td></td>

  1940.           <td>)</td>

  1941.           <td></td><td></td>

  1942.         </tr>

  1943.       </table>

  1944.   </td>

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

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

  1947.   </tr>

  1948. </table>

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

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

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

  1952.   <table class="params">

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

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

  1955.   </table>

  1956.   </dd>

  1957. </dl>

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

  1959. 

  1960. </div>

  1961. </div>

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

  1963. <div class="memitem">

  1964. <div class="memproto">

  1965. <table class="mlabels">

  1966.   <tr>

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

  1968.       <table class="memname">

  1969.         <tr>

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

  1971.           <td>(</td>

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

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

  1974.         </tr>

  1975.         <tr>

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

  1977.           <td></td>

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

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

  1980.         </tr>

  1981.         <tr>

  1982.           <td></td>

  1983.           <td>)</td>

  1984.           <td></td><td></td>

  1985.         </tr>

  1986.       </table>

  1987.   </td>

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

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

  1990.   </tr>

  1991. </table>

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

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

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

  1995.   <table class="params">

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

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

  1998.   </table>

  1999.   </dd>

  2000. </dl>

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

  2002. 

  2003. </div>

  2004. </div>

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

  2006. <div class="memitem">

  2007. <div class="memproto">

  2008. <table class="mlabels">

  2009.   <tr>

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

  2011.       <table class="memname">

  2012.         <tr>

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

  2014.           <td>(</td>

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

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

  2017.           <td></td>

  2018.         </tr>

  2019.       </table>

  2020.   </td>

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

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

  2023.   </tr>

  2024. </table>

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

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

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

  2028.   <table class="params">

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

  2030.   </table>

  2031.   </dd>

  2032. </dl>

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

  2034. 

  2035. </div>

  2036. </div>

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

  2038. <div class="memitem">

  2039. <div class="memproto">

  2040. <table class="mlabels">

  2041.   <tr>

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

  2043.       <table class="memname">

  2044.         <tr>

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

  2046.           <td>(</td>

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

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

  2049.         </tr>

  2050.         <tr>

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

  2052.           <td></td>

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

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

  2055.         </tr>

  2056.         <tr>

  2057.           <td></td>

  2058.           <td>)</td>

  2059.           <td></td><td></td>

  2060.         </tr>

  2061.       </table>

  2062.   </td>

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

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

  2065.   </tr>

  2066. </table>

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

  2068. <p>Rename a file or subdirectory.</p>

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

  2070.   <table class="params">

  2071.     <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>

  2072.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>

  2073.   </table>

  2074.   </dd>

  2075. </dl>

  2076. <p>The <em>newPath</em> object must not exist before the rename call.</p>

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

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

  2079. 

  2080. </div>

  2081. </div>

  2082. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>

  2083. <div class="memitem">

  2084. <div class="memproto">

  2085. <table class="mlabels">

  2086.   <tr>

  2087.   <td class="mlabels-left">

  2088.       <table class="memname">

  2089.         <tr>

  2090.           <td class="memname">bool FatFileSystem::rmdir </td>

  2091.           <td>(</td>

  2092.           <td class="paramtype">const char *&#160;</td>

  2093.           <td class="paramname"><em>path</em></td><td>)</td>

  2094.           <td></td>

  2095.         </tr>

  2096.       </table>

  2097.   </td>

  2098.   <td class="mlabels-right">

  2099. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2100.   </tr>

  2101. </table>

  2102. </div><div class="memdoc">

  2103. <p>Remove a subdirectory from the volume's working directory.</p>

  2104. <dl class="params"><dt>Parameters</dt><dd>

  2105.   <table class="params">

  2106.     <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>

  2107.   </table>

  2108.   </dd>

  2109. </dl>

  2110. <p>The subdirectory file will be removed only if it is empty.</p>

  2111. <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>

  2112. 

  2113. </div>

  2114. </div>

  2115. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>

  2116. <div class="memitem">

  2117. <div class="memproto">

  2118. <table class="mlabels">

  2119.   <tr>

  2120.   <td class="mlabels-left">

  2121.       <table class="memname">

  2122.         <tr>

  2123.           <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>

  2124.           <td>(</td>

  2125.           <td class="paramname"></td><td>)</td>

  2126.           <td> const</td>

  2127.         </tr>

  2128.       </table>

  2129.   </td>

  2130.   <td class="mlabels-right">

  2131. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2132.   </tr>

  2133. </table>

  2134. </div><div class="memdoc">

  2135. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>

  2136. 

  2137. </div>

  2138. </div>

  2139. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>

  2140. <div class="memitem">

  2141. <div class="memproto">

  2142. <table class="mlabels">

  2143.   <tr>

  2144.   <td class="mlabels-left">

  2145.       <table class="memname">

  2146.         <tr>

  2147.           <td class="memname">uint32_t FatVolume::rootDirStart </td>

  2148.           <td>(</td>

  2149.           <td class="paramname"></td><td>)</td>

  2150.           <td> const</td>

  2151.         </tr>

  2152.       </table>

  2153.   </td>

  2154.   <td class="mlabels-right">

  2155. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2156.   </tr>

  2157. </table>

  2158. </div><div class="memdoc">

  2159. <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>

  2160. 

  2161. </div>

  2162. </div>

  2163. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>

  2164. <div class="memitem">

  2165. <div class="memproto">

  2166. <table class="mlabels">

  2167.   <tr>

  2168.   <td class="mlabels-left">

  2169.       <table class="memname">

  2170.         <tr>

  2171.           <td class="memname">bool FatFileSystem::truncate </td>

  2172.           <td>(</td>

  2173.           <td class="paramtype">const char *&#160;</td>

  2174.           <td class="paramname"><em>path</em>, </td>

  2175.         </tr>

  2176.         <tr>

  2177.           <td class="paramkey"></td>

  2178.           <td></td>

  2179.           <td class="paramtype">uint32_t&#160;</td>

  2180.           <td class="paramname"><em>length</em>&#160;</td>

  2181.         </tr>

  2182.         <tr>

  2183.           <td></td>

  2184.           <td>)</td>

  2185.           <td></td><td></td>

  2186.         </tr>

  2187.       </table>

  2188.   </td>

  2189.   <td class="mlabels-right">

  2190. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2191.   </tr>

  2192. </table>

  2193. </div><div class="memdoc">

  2194. <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>

  2195. <dl class="params"><dt>Parameters</dt><dd>

  2196.   <table class="params">

  2197.     <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>

  2198.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2199.   </table>

  2200.   </dd>

  2201. </dl>

  2202. <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>

  2203. 

  2204. </div>

  2205. </div>

  2206. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>

  2207. <div class="memitem">

  2208. <div class="memproto">

  2209. <table class="mlabels">

  2210.   <tr>

  2211.   <td class="mlabels-left">

  2212.       <table class="memname">

  2213.         <tr>

  2214.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>

  2215.           <td>(</td>

  2216.           <td class="paramname"></td><td>)</td>

  2217.           <td></td>

  2218.         </tr>

  2219.       </table>

  2220.   </td>

  2221.   <td class="mlabels-right">

  2222. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2223.   </tr>

  2224. </table>

  2225. </div><div class="memdoc">

  2226. <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>

  2227. 

  2228. </div>

  2229. </div>

  2230. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>

  2231. <div class="memitem">

  2232. <div class="memproto">

  2233. <table class="mlabels">

  2234.   <tr>

  2235.   <td class="mlabels-left">

  2236.       <table class="memname">

  2237.         <tr>

  2238.           <td class="memname">uint32_t FatVolume::volumeBlockCount </td>

  2239.           <td>(</td>

  2240.           <td class="paramname"></td><td>)</td>

  2241.           <td> const</td>

  2242.         </tr>

  2243.       </table>

  2244.   </td>

  2245.   <td class="mlabels-right">

  2246. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2247.   </tr>

  2248. </table>

  2249. </div><div class="memdoc">

  2250. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>

  2251. 

  2252. </div>

  2253. </div>

  2254. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>

  2255. <div class="memitem">

  2256. <div class="memproto">

  2257. <table class="mlabels">

  2258.   <tr>

  2259.   <td class="mlabels-left">

  2260.       <table class="memname">

  2261.         <tr>

  2262.           <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>

  2263.           <td>(</td>

  2264.           <td class="paramname"></td><td>)</td>

  2265.           <td></td>

  2266.         </tr>

  2267.       </table>

  2268.   </td>

  2269.   <td class="mlabels-right">

  2270. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2271.   </tr>

  2272. </table>

  2273. </div><div class="memdoc">

  2274. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>

  2275. 

  2276. </div>

  2277. </div>

  2278. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>

  2279. <div class="memitem">

  2280. <div class="memproto">

  2281. <table class="mlabels">

  2282.   <tr>

  2283.   <td class="mlabels-left">

  2284.       <table class="memname">

  2285.         <tr>

  2286.           <td class="memname">bool FatFileSystem::wipe </td>

  2287.           <td>(</td>

  2288.           <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>

  2289.           <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>

  2290.           <td></td>

  2291.         </tr>

  2292.       </table>

  2293.   </td>

  2294.   <td class="mlabels-right">

  2295. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span>  </td>

  2296.   </tr>

  2297. </table>

  2298. </div><div class="memdoc">

  2299. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>

  2300.   <table class="params">

  2301.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>

  2302.   </table>

  2303.   </dd>

  2304. </dl>

  2305. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  2306. 

  2307. </div>

  2308. </div>

  2309. <hr/>The documentation for this class was generated from the following file:<ul>

  2310. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  2311. </ul>

  2312. </div><!-- contents -->

  2313. <!-- start footer part -->

  2314. <hr class="footer"/><address class="footer"><small>

  2315. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2316. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2317. </a> 1.8.10

  2318. </small></address>

  2319. </body>

  2320. </html>