visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 Commits
1 Branch
Tree: 7871875f5c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7871875f5c'
${ noResults }
teensy-sdfat/extras/html/class_sd_fat.html

2437 lines
105KB
Raw Blame History 

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

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

  3. <head>

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

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

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

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

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

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

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

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

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

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

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

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

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

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

  66.     </ul>

  67.   </div>

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

  69. <div id="MSearchSelectWindow"

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

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

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

  73. </div>

  74. 

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

  76. <div id="MSearchResultsWindow">

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

  78.         name="MSearchResults" id="MSearchResults">

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

  86. <a href="class_sd_fat-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

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

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

  90. <div class="contents">

  91. 

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

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

  94. 

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

  96. <div class="dynheader">

  97. Inheritance diagram for SdFat:</div>

  98. <div class="dyncontent">

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

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

  101. <area shape="rect" id="node2" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCard \&gt;" alt="" coords="5,155,196,181"/>

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

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

  104. </map>

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

  106. <div class="dynheader">

  107. Collaboration diagram for SdFat:</div>

  108. <div class="dyncontent">

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

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

  111. <area shape="rect" id="node2" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCard \&gt;" alt="" coords="5,155,196,181"/>

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

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

  114. </map>

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

  116. <table class="memberdecls">

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

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

  119. <tr class="memitem:a5dda20d3dcbfc8c641babbb2c9aac382"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a5dda20d3dcbfc8c641babbb2c9aac382">begin</a> (<a class="el" href="_block_driver_8h.html#ace97f2377acdc471a01f9f7ec1fd6bbb">BlockDriver</a> *blockDev, uint8_t part=0)</td></tr>

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

  121. <tr class="memitem:ad94237ef45c52698e97b04e8c131f21e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin</a> ()</td></tr>

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

  123. <tr class="memitem:abfafe10a64b28e6c1698ed82d340f624"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#abfafe10a64b28e6c1698ed82d340f624">begin</a> (uint8_t csPin=SS, SPISettings spiSettings=SPI_FULL_SPEED)</td></tr>

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

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

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

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

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

  129. <tr class="memitem:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioncache__t.html">cache_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#aa1e3b1d0c21d202deb82668068ab00e8">cacheClear</a> ()</td></tr>

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

  131. <tr class="memitem:ab5dcfbeeb7caa38a38db86003341eb07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab5dcfbeeb7caa38a38db86003341eb07">card</a> ()</td></tr>

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

  133. <tr class="memitem:ae380e4572776db851b2f80a3ed143fca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#ae380e4572776db851b2f80a3ed143fca">cardBegin</a> (uint8_t csPin=SS, SPISettings settings=SPI_FULL_SPEED)</td></tr>

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

  135. <tr class="memitem:aedfd5a0830c955bc5514e52f2f2dd066"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#aedfd5a0830c955bc5514e52f2f2dd066">cardErrorCode</a> ()</td></tr>

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

  137. <tr class="memitem:a0602ab3c04ea33293649f0a15fc81e05"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a0602ab3c04ea33293649f0a15fc81e05">cardErrorData</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  153. <tr class="memitem:a855267374306bfee2df67642c99d4d18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a855267374306bfee2df67642c99d4d18">errorHalt</a> ()</td></tr>

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

  155. <tr class="memitem:ae1f79a2974ebe134e70f898c32d97e98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ae1f79a2974ebe134e70f898c32d97e98">errorHalt</a> (Print *pr)</td></tr>

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

  157. <tr class="memitem:a32c20dfa6a8cb8af95f25847b19bdbca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a32c20dfa6a8cb8af95f25847b19bdbca">errorHalt</a> (char const *msg)</td></tr>

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

  159. <tr class="memitem:a27fb329d6aee79a63c20386218ce7e9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a27fb329d6aee79a63c20386218ce7e9e">errorHalt</a> (Print *pr, char const *msg)</td></tr>

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

  161. <tr class="memitem:af856494745a9842d9728dfeabf19c51e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#af856494745a9842d9728dfeabf19c51e">errorHalt</a> (const __FlashStringHelper *msg)</td></tr>

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

  163. <tr class="memitem:a746c80d048c30baf0b281e16932670a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a746c80d048c30baf0b281e16932670a2">errorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

  165. <tr class="memitem:ab0b78154d6874c29279ba81f36ccb09c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab0b78154d6874c29279ba81f36ccb09c">errorPrint</a> ()</td></tr>

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

  167. <tr class="memitem:a03736274debea71fef5e2ff34d7ec3dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a03736274debea71fef5e2ff34d7ec3dc">errorPrint</a> (Print *pr)</td></tr>

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

  169. <tr class="memitem:a2e2436b7b2666737cbaf4b22218bc69f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a2e2436b7b2666737cbaf4b22218bc69f">errorPrint</a> (const char *msg)</td></tr>

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

  171. <tr class="memitem:a0eb6b92a0700ba932f6127962981d153"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a0eb6b92a0700ba932f6127962981d153">errorPrint</a> (Print *pr, char const *msg)</td></tr>

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

  173. <tr class="memitem:a1ccb1f937f42e9c1331c942bc357f6da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a1ccb1f937f42e9c1331c942bc357f6da">errorPrint</a> (const __FlashStringHelper *msg)</td></tr>

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

  175. <tr class="memitem:a43344a079d9af92ea4b550914d0512f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a43344a079d9af92ea4b550914d0512f6">errorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  187. <tr class="memitem:add6a9a3ad07585f6e0e5c35e35cacb9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#add6a9a3ad07585f6e0e5c35e35cacb9a">fsBegin</a> ()</td></tr>

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

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

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

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

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

  193. <tr class="memitem:a8e1f26486bb878a24fa9868e59dbbbc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a8e1f26486bb878a24fa9868e59dbbbc2">initErrorHalt</a> ()</td></tr>

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

  195. <tr class="memitem:a24bd0f699cf0fe11fd2148b15c49251a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a24bd0f699cf0fe11fd2148b15c49251a">initErrorHalt</a> (Print *pr)</td></tr>

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

  197. <tr class="memitem:a893833a880e2a83757480ba4c1351041"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a893833a880e2a83757480ba4c1351041">initErrorHalt</a> (char const *msg)</td></tr>

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

  199. <tr class="memitem:a3077b1a53d789d0401b707963cb28f46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a3077b1a53d789d0401b707963cb28f46">initErrorHalt</a> (Print *pr, char const *msg)</td></tr>

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

  201. <tr class="memitem:a2a1e4cc8056ba23b55dfa2c6486b8798"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a2a1e4cc8056ba23b55dfa2c6486b8798">initErrorHalt</a> (const __FlashStringHelper *msg)</td></tr>

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

  203. <tr class="memitem:ab03d98012dea18733c3252f27832de69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ab03d98012dea18733c3252f27832de69">initErrorHalt</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

  205. <tr class="memitem:ae31c9cbd7e1c03129d6c99b25f73cd50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ae31c9cbd7e1c03129d6c99b25f73cd50">initErrorPrint</a> ()</td></tr>

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

  207. <tr class="memitem:a066707dce0667213b5f083d59f67448d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a066707dce0667213b5f083d59f67448d">initErrorPrint</a> (Print *pr)</td></tr>

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

  209. <tr class="memitem:a538796f79fd9db9c5bbeefd9defe639a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a538796f79fd9db9c5bbeefd9defe639a">initErrorPrint</a> (char const *msg)</td></tr>

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

  211. <tr class="memitem:ad9855d33ebd465715b706d0926291b13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad9855d33ebd465715b706d0926291b13">initErrorPrint</a> (Print *pr, char const *msg)</td></tr>

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

  213. <tr class="memitem:ad6ffec5a7d82be46d46b8a4f82d0803b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#ad6ffec5a7d82be46d46b8a4f82d0803b">initErrorPrint</a> (const __FlashStringHelper *msg)</td></tr>

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

  215. <tr class="memitem:a8a2018b6366145a9843d3d29a47d6560"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file_system.html#a8a2018b6366145a9843d3d29a47d6560">initErrorPrint</a> (Print *pr, const __FlashStringHelper *msg)</td></tr>

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

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

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

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

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

  221. <tr class="memitem:ae12fb8bfad5c4a8e052dda70a5a0ed93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#ae12fb8bfad5c4a8e052dda70a5a0ed93">ls</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr, uint8_t flags=0)</td></tr>

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

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

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

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

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

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

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

  229. <tr class="memitem:a0abfb1f754a8fb559cfa884ee040f56f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_file_system.html#a0abfb1f754a8fb559cfa884ee040f56f">open</a> (const String &amp;path, uint8_t mode=<a class="el" href="_arduino_files_8h.html#ad52d51659a75e25d96fb04d22ff718cb">FILE_READ</a>)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  241. <tr class="memitem:a232871b6bbd0f40d6a2883b3c7b0425f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat.html#a232871b6bbd0f40d6a2883b3c7b0425f">SdFat</a> (uint8_t spiPort)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

  253. </table>

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

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

  256. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  257. <a class="anchor" id="a232871b6bbd0f40d6a2883b3c7b0425f"></a>

  258. <div class="memitem">

  259. <div class="memproto">

  260. <table class="mlabels">

  261.   <tr>

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

  263.       <table class="memname">

  264.         <tr>

  265.           <td class="memname">SdFat::SdFat </td>

  266.           <td>(</td>

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

  268.           <td class="paramname"><em>spiPort</em></td><td>)</td>

  269.           <td></td>

  270.         </tr>

  271.       </table>

  272.   </td>

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

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

  275.   </tr>

  276. </table>

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

  278. <p>Constructor with SPI port selection. </p><dl class="params"><dt>Parameters</dt><dd>

  279.   <table class="params">

  280.     <tr><td class="paramdir">[in]</td><td class="paramname">spiPort</td><td>SPI port number. </td></tr>

  281.   </table>

  282.   </dd>

  283. </dl>

  284. 

  285. </div>

  286. </div>

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

  288. <a class="anchor" id="a5dda20d3dcbfc8c641babbb2c9aac382"></a>

  289. <div class="memitem">

  290. <div class="memproto">

  291. <table class="mlabels">

  292.   <tr>

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

  294.       <table class="memname">

  295.         <tr>

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

  297.           <td>(</td>

  298.           <td class="paramtype"><a class="el" href="_block_driver_8h.html#ace97f2377acdc471a01f9f7ec1fd6bbb">BlockDriver</a> *&#160;</td>

  299.           <td class="paramname"><em>blockDev</em>, </td>

  300.         </tr>

  301.         <tr>

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

  303.           <td></td>

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

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

  306.         </tr>

  307.         <tr>

  308.           <td></td>

  309.           <td>)</td>

  310.           <td></td><td></td>

  311.         </tr>

  312.       </table>

  313.   </td>

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

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

  316.   </tr>

  317. </table>

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

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

  320.   <table class="params">

  321.     <tr><td class="paramdir">[in]</td><td class="paramname">blockDev</td><td>Device block driver. </td></tr>

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

  323.   </table>

  324.   </dd>

  325. </dl>

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

  327. 

  328. </div>

  329. </div>

  330. <a class="anchor" id="ad94237ef45c52698e97b04e8c131f21e"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::begin </td>

  339.           <td>(</td>

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

  341.           <td></td>

  342.         </tr>

  343.       </table>

  344.   </td>

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

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

  347.   </tr>

  348. </table>

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

  350. <p>Initialize file system. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  351. 

  352. </div>

  353. </div>

  354. <a class="anchor" id="abfafe10a64b28e6c1698ed82d340f624"></a>

  355. <div class="memitem">

  356. <div class="memproto">

  357. <table class="mlabels">

  358.   <tr>

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

  360.       <table class="memname">

  361.         <tr>

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

  363.           <td>(</td>

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

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

  366.         </tr>

  367.         <tr>

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

  369.           <td></td>

  370.           <td class="paramtype">SPISettings&#160;</td>

  371.           <td class="paramname"><em>spiSettings</em> = <code>SPI_FULL_SPEED</code>&#160;</td>

  372.         </tr>

  373.         <tr>

  374.           <td></td>

  375.           <td>)</td>

  376.           <td></td><td></td>

  377.         </tr>

  378.       </table>

  379.   </td>

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

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

  382.   </tr>

  383. </table>

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

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

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

  387.   <table class="params">

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

  389.     <tr><td class="paramdir">[in]</td><td class="paramname">spiSettings</td><td>SPI speed, mode, and bit order. </td></tr>

  390.   </table>

  391.   </dd>

  392. </dl>

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

  394. 

  395. </div>

  396. </div>

  397. <a class="anchor" id="a06beed4cea5e38116b58254a57125442"></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">uint8_t FatVolume::blocksPerCluster </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 volume's cluster size in blocks. </dd></dl>

  418. 

  419. </div>

  420. </div>

  421. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></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">uint32_t FatVolume::blocksPerFat </td>

  430.           <td>(</td>

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

  432.           <td> const</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. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>

  442. 

  443. </div>

  444. </div>

  445. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></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="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </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. <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>

  466. 

  467. </div>

  468. </div>

  469. <a class="anchor" id="ab5dcfbeeb7caa38a38db86003341eb07"></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"><a class="el" href="class_sd_spi_card.html">SdSpiCard</a> * <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::card </td>

  478.           <td>(</td>

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

  480.           <td></td>

  481.         </tr>

  482.       </table>

  483.   </td>

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

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

  486.   </tr>

  487. </table>

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

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

  490. 

  491. </div>

  492. </div>

  493. <a class="anchor" id="ae380e4572776db851b2f80a3ed143fca"></a>

  494. <div class="memitem">

  495. <div class="memproto">

  496. <table class="mlabels">

  497.   <tr>

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

  499.       <table class="memname">

  500.         <tr>

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

  502.           <td>(</td>

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

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

  505.         </tr>

  506.         <tr>

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

  508.           <td></td>

  509.           <td class="paramtype">SPISettings&#160;</td>

  510.           <td class="paramname"><em>settings</em> = <code>SPI_FULL_SPEED</code>&#160;</td>

  511.         </tr>

  512.         <tr>

  513.           <td></td>

  514.           <td>)</td>

  515.           <td></td><td></td>

  516.         </tr>

  517.       </table>

  518.   </td>

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

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

  521.   </tr>

  522. </table>

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

  524. <p>Initialize SD card for diagnostic use only.</p>

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

  526.   <table class="params">

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

  528.     <tr><td class="paramdir">[in]</td><td class="paramname">settings</td><td>SPI speed, mode, and bit order. </td></tr>

  529.   </table>

  530.   </dd>

  531. </dl>

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

  533. 

  534. </div>

  535. </div>

  536. <a class="anchor" id="aedfd5a0830c955bc5514e52f2f2dd066"></a>

  537. <div class="memitem">

  538. <div class="memproto">

  539. <table class="mlabels">

  540.   <tr>

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

  542.       <table class="memname">

  543.         <tr>

  544.           <td class="memname">uint8_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::cardErrorCode </td>

  545.           <td>(</td>

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

  547.           <td></td>

  548.         </tr>

  549.       </table>

  550.   </td>

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

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

  553.   </tr>

  554. </table>

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

  556. <dl class="section return"><dt>Returns</dt><dd>The card error code </dd></dl>

  557. 

  558. </div>

  559. </div>

  560. <a class="anchor" id="a0602ab3c04ea33293649f0a15fc81e05"></a>

  561. <div class="memitem">

  562. <div class="memproto">

  563. <table class="mlabels">

  564.   <tr>

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

  566.       <table class="memname">

  567.         <tr>

  568.           <td class="memname">uint32_t <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::cardErrorData </td>

  569.           <td>(</td>

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

  571.           <td></td>

  572.         </tr>

  573.       </table>

  574.   </td>

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

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

  577.   </tr>

  578. </table>

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

  580. <dl class="section return"><dt>Returns</dt><dd>the card error data </dd></dl>

  581. 

  582. </div>

  583. </div>

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

  585. <div class="memitem">

  586. <div class="memproto">

  587. <table class="mlabels">

  588.   <tr>

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

  590.       <table class="memname">

  591.         <tr>

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

  593.           <td>(</td>

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

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

  596.           <td></td>

  597.         </tr>

  598.       </table>

  599.   </td>

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

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

  602.   </tr>

  603. </table>

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

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

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

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

  608.   <table class="params">

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

  610.   </table>

  611.   </dd>

  612. </dl>

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

  614. 

  615. </div>

  616. </div>

  617. <a class="anchor" id="a44af1b98e8d986d12107b654453acbc4"></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">bool FatFileSystem::chdir </td>

  626.           <td>(</td>

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

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

  629.         </tr>

  630.         <tr>

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

  632.           <td></td>

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

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

  635.         </tr>

  636.         <tr>

  637.           <td></td>

  638.           <td>)</td>

  639.           <td></td><td></td>

  640.         </tr>

  641.       </table>

  642.   </td>

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

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

  645.   </tr>

  646. </table>

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

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

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

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

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

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

  653.   <table class="params">

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

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

  656.   </table>

  657.   </dd>

  658. </dl>

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

  660. 

  661. </div>

  662. </div>

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

  664. <div class="memitem">

  665. <div class="memproto">

  666. <table class="mlabels">

  667.   <tr>

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

  669.       <table class="memname">

  670.         <tr>

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

  672.           <td>(</td>

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

  674.           <td></td>

  675.         </tr>

  676.       </table>

  677.   </td>

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

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

  680.   </tr>

  681. </table>

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

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

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

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

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

  687. 

  688. </div>

  689. </div>

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

  691. <div class="memitem">

  692. <div class="memproto">

  693. <table class="mlabels">

  694.   <tr>

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

  696.       <table class="memname">

  697.         <tr>

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

  699.           <td>(</td>

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

  701.           <td> const</td>

  702.         </tr>

  703.       </table>

  704.   </td>

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

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

  707.   </tr>

  708. </table>

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

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

  711. 

  712. </div>

  713. </div>

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

  715. <div class="memitem">

  716. <div class="memproto">

  717. <table class="mlabels">

  718.   <tr>

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

  720.       <table class="memname">

  721.         <tr>

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

  723.           <td>(</td>

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

  725.           <td> const</td>

  726.         </tr>

  727.       </table>

  728.   </td>

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

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

  731.   </tr>

  732. </table>

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

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

  735. 

  736. </div>

  737. </div>

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

  739. <div class="memitem">

  740. <div class="memproto">

  741. <table class="mlabels">

  742.   <tr>

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

  744.       <table class="memname">

  745.         <tr>

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

  747.           <td>(</td>

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

  749.           <td> const</td>

  750.         </tr>

  751.       </table>

  752.   </td>

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

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

  755.   </tr>

  756. </table>

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

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

  759. 

  760. </div>

  761. </div>

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

  763. <div class="memitem">

  764. <div class="memproto">

  765. <table class="mlabels">

  766.   <tr>

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

  768.       <table class="memname">

  769.         <tr>

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

  771.           <td>(</td>

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

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

  774.         </tr>

  775.         <tr>

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

  777.           <td></td>

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

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

  780.         </tr>

  781.         <tr>

  782.           <td></td>

  783.           <td>)</td>

  784.           <td></td><td></td>

  785.         </tr>

  786.       </table>

  787.   </td>

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

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

  790.   </tr>

  791. </table>

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

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

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

  795.   <table class="params">

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

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

  798.   </table>

  799.   </dd>

  800. </dl>

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

  802. 

  803. </div>

  804. </div>

  805. <a class="anchor" id="a855267374306bfee2df67642c99d4d18"></a>

  806. <div class="memitem">

  807. <div class="memproto">

  808. <table class="mlabels">

  809.   <tr>

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

  811.       <table class="memname">

  812.         <tr>

  813.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorHalt </td>

  814.           <td>(</td>

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

  816.           <td></td>

  817.         </tr>

  818.       </table>

  819.   </td>

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

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

  822.   </tr>

  823. </table>

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

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

  826. 

  827. </div>

  828. </div>

  829. <a class="anchor" id="ae1f79a2974ebe134e70f898c32d97e98"></a>

  830. <div class="memitem">

  831. <div class="memproto">

  832. <table class="mlabels">

  833.   <tr>

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

  835.       <table class="memname">

  836.         <tr>

  837.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorHalt </td>

  838.           <td>(</td>

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

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

  841.           <td></td>

  842.         </tr>

  843.       </table>

  844.   </td>

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

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

  847.   </tr>

  848. </table>

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

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

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

  852.   <table class="params">

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

  854.   </table>

  855.   </dd>

  856. </dl>

  857. 

  858. </div>

  859. </div>

  860. <a class="anchor" id="a32c20dfa6a8cb8af95f25847b19bdbca"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorHalt </td>

  869.           <td>(</td>

  870.           <td class="paramtype">char const *&#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="a27fb329d6aee79a63c20386218ce7e9e"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorHalt </td>

  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">char const *&#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">inline</span><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="af856494745a9842d9728dfeabf19c51e"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorHalt </td>

  942.           <td>(</td>

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

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

  945.           <td></td>

  946.         </tr>

  947.       </table>

  948.   </td>

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

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

  951.   </tr>

  952. </table>

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

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

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

  956.   <table class="params">

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

  958.   </table>

  959.   </dd>

  960. </dl>

  961. 

  962. </div>

  963. </div>

  964. <a class="anchor" id="a746c80d048c30baf0b281e16932670a2"></a>

  965. <div class="memitem">

  966. <div class="memproto">

  967. <table class="mlabels">

  968.   <tr>

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

  970.       <table class="memname">

  971.         <tr>

  972.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorHalt </td>

  973.           <td>(</td>

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

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

  976.         </tr>

  977.         <tr>

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

  979.           <td></td>

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

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

  982.         </tr>

  983.         <tr>

  984.           <td></td>

  985.           <td>)</td>

  986.           <td></td><td></td>

  987.         </tr>

  988.       </table>

  989.   </td>

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

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

  992.   </tr>

  993. </table>

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

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

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

  997.   <table class="params">

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

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

  1000.   </table>

  1001.   </dd>

  1002. </dl>

  1003. 

  1004. </div>

  1005. </div>

  1006. <a class="anchor" id="ab0b78154d6874c29279ba81f36ccb09c"></a>

  1007. <div class="memitem">

  1008. <div class="memproto">

  1009. <table class="mlabels">

  1010.   <tr>

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

  1012.       <table class="memname">

  1013.         <tr>

  1014.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorPrint </td>

  1015.           <td>(</td>

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

  1017.           <td></td>

  1018.         </tr>

  1019.       </table>

  1020.   </td>

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

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

  1023.   </tr>

  1024. </table>

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

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

  1027. 

  1028. </div>

  1029. </div>

  1030. <a class="anchor" id="a03736274debea71fef5e2ff34d7ec3dc"></a>

  1031. <div class="memitem">

  1032. <div class="memproto">

  1033. <table class="mlabels">

  1034.   <tr>

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

  1036.       <table class="memname">

  1037.         <tr>

  1038.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorPrint </td>

  1039.           <td>(</td>

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

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

  1042.           <td></td>

  1043.         </tr>

  1044.       </table>

  1045.   </td>

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

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

  1048.   </tr>

  1049. </table>

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

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

  1052.   <table class="params">

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

  1054.   </table>

  1055.   </dd>

  1056. </dl>

  1057. 

  1058. </div>

  1059. </div>

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

  1061. <div class="memitem">

  1062. <div class="memproto">

  1063. <table class="mlabels">

  1064.   <tr>

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

  1066.       <table class="memname">

  1067.         <tr>

  1068.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorPrint </td>

  1069.           <td>(</td>

  1070.           <td class="paramtype">const char *&#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="a0eb6b92a0700ba932f6127962981d153"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorPrint </td>

  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">char const *&#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">inline</span><span class="mlabel">inherited</span></span>  </td>

  1119.   </tr>

  1120. </table>

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

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

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

  1124.   <table class="params">

  1125.     <tr><td class="paramdir">[in]</td><td class="paramname">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="a1ccb1f937f42e9c1331c942bc357f6da"></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">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorPrint </td>

  1142.           <td>(</td>

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

  1144.           <td class="paramname"><em>msg</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>Print msg, any SD error code.</p>

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

  1156.   <table class="params">

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

  1158.   </table>

  1159.   </dd>

  1160. </dl>

  1161. 

  1162. </div>

  1163. </div>

  1164. <a class="anchor" id="a43344a079d9af92ea4b550914d0512f6"></a>

  1165. <div class="memitem">

  1166. <div class="memproto">

  1167. <table class="mlabels">

  1168.   <tr>

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

  1170.       <table class="memname">

  1171.         <tr>

  1172.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::errorPrint </td>

  1173.           <td>(</td>

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

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

  1176.         </tr>

  1177.         <tr>

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

  1179.           <td></td>

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

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

  1182.         </tr>

  1183.         <tr>

  1184.           <td></td>

  1185.           <td>)</td>

  1186.           <td></td><td></td>

  1187.         </tr>

  1188.       </table>

  1189.   </td>

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

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

  1192.   </tr>

  1193. </table>

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

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

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

  1197.   <table class="params">

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

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

  1200.   </table>

  1201.   </dd>

  1202. </dl>

  1203. 

  1204. </div>

  1205. </div>

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

  1207. <div class="memitem">

  1208. <div class="memproto">

  1209. <table class="mlabels">

  1210.   <tr>

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

  1212.       <table class="memname">

  1213.         <tr>

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

  1215.           <td>(</td>

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

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

  1218.           <td></td>

  1219.         </tr>

  1220.       </table>

  1221.   </td>

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

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

  1224.   </tr>

  1225. </table>

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

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

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

  1229.   <table class="params">

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

  1231.   </table>

  1232.   </dd>

  1233. </dl>

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

  1235. 

  1236. </div>

  1237. </div>

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

  1239. <div class="memitem">

  1240. <div class="memproto">

  1241. <table class="mlabels">

  1242.   <tr>

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

  1244.       <table class="memname">

  1245.         <tr>

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

  1247.           <td>(</td>

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

  1249.           <td></td>

  1250.         </tr>

  1251.       </table>

  1252.   </td>

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

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

  1255.   </tr>

  1256. </table>

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

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

  1259. 

  1260. </div>

  1261. </div>

  1262. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></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">uint32_t FatVolume::fatStartBlock </td>

  1271.           <td>(</td>

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

  1273.           <td> const</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. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>

  1283. 

  1284. </div>

  1285. </div>

  1286. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></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">uint8_t FatVolume::fatType </td>

  1295.           <td>(</td>

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

  1297.           <td> const</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. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>

  1307. 

  1308. </div>

  1309. </div>

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

  1311. <div class="memitem">

  1312. <div class="memproto">

  1313. <table class="mlabels">

  1314.   <tr>

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

  1316.       <table class="memname">

  1317.         <tr>

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

  1319.           <td>(</td>

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

  1321.           <td></td>

  1322.         </tr>

  1323.       </table>

  1324.   </td>

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

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

  1327.   </tr>

  1328. </table>

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

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

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

  1332. 

  1333. </div>

  1334. </div>

  1335. <a class="anchor" id="add6a9a3ad07585f6e0e5c35e35cacb9a"></a>

  1336. <div class="memitem">

  1337. <div class="memproto">

  1338. <table class="mlabels">

  1339.   <tr>

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

  1341.       <table class="memname">

  1342.         <tr>

  1343.           <td class="memname">bool SdFat::fsBegin </td>

  1344.           <td>(</td>

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

  1346.           <td></td>

  1347.         </tr>

  1348.       </table>

  1349.   </td>

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

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

  1352.   </tr>

  1353. </table>

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

  1355. <p>Initialize file system for diagnostic use only. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>

  1356. 

  1357. </div>

  1358. </div>

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

  1360. <div class="memitem">

  1361. <div class="memproto">

  1362. <table class="mlabels">

  1363.   <tr>

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

  1365.       <table class="memname">

  1366.         <tr>

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

  1368.           <td>(</td>

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

  1370.           <td></td>

  1371.         </tr>

  1372.       </table>

  1373.   </td>

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

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

  1376.   </tr>

  1377. </table>

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

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

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

  1381. 

  1382. </div>

  1383. </div>

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

  1385. <div class="memitem">

  1386. <div class="memproto">

  1387. <table class="mlabels">

  1388.   <tr>

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

  1390.       <table class="memname">

  1391.         <tr>

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

  1393.           <td>(</td>

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

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

  1396.           <td></td>

  1397.         </tr>

  1398.       </table>

  1399.   </td>

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

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

  1402.   </tr>

  1403. </table>

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

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

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

  1407.   <table class="params">

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

  1409.   </table>

  1410.   </dd>

  1411. </dl>

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

  1413. 

  1414. </div>

  1415. </div>

  1416. <a class="anchor" id="a8e1f26486bb878a24fa9868e59dbbbc2"></a>

  1417. <div class="memitem">

  1418. <div class="memproto">

  1419. <table class="mlabels">

  1420.   <tr>

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

  1422.       <table class="memname">

  1423.         <tr>

  1424.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorHalt </td>

  1425.           <td>(</td>

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

  1427.           <td></td>

  1428.         </tr>

  1429.       </table>

  1430.   </td>

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

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

  1433.   </tr>

  1434. </table>

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

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

  1437. 

  1438. </div>

  1439. </div>

  1440. <a class="anchor" id="a24bd0f699cf0fe11fd2148b15c49251a"></a>

  1441. <div class="memitem">

  1442. <div class="memproto">

  1443. <table class="mlabels">

  1444.   <tr>

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

  1446.       <table class="memname">

  1447.         <tr>

  1448.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorHalt </td>

  1449.           <td>(</td>

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

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

  1452.           <td></td>

  1453.         </tr>

  1454.       </table>

  1455.   </td>

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

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

  1458.   </tr>

  1459. </table>

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

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

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

  1463.   <table class="params">

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

  1465.   </table>

  1466.   </dd>

  1467. </dl>

  1468. 

  1469. </div>

  1470. </div>

  1471. <a class="anchor" id="a893833a880e2a83757480ba4c1351041"></a>

  1472. <div class="memitem">

  1473. <div class="memproto">

  1474. <table class="mlabels">

  1475.   <tr>

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

  1477.       <table class="memname">

  1478.         <tr>

  1479.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorHalt </td>

  1480.           <td>(</td>

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

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

  1483.           <td></td>

  1484.         </tr>

  1485.       </table>

  1486.   </td>

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

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

  1489.   </tr>

  1490. </table>

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

  1492. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>

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

  1494.   <table class="params">

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

  1496.   </table>

  1497.   </dd>

  1498. </dl>

  1499. 

  1500. </div>

  1501. </div>

  1502. <a class="anchor" id="a3077b1a53d789d0401b707963cb28f46"></a>

  1503. <div class="memitem">

  1504. <div class="memproto">

  1505. <table class="mlabels">

  1506.   <tr>

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

  1508.       <table class="memname">

  1509.         <tr>

  1510.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorHalt </td>

  1511.           <td>(</td>

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

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

  1514.         </tr>

  1515.         <tr>

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

  1517.           <td></td>

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

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

  1520.         </tr>

  1521.         <tr>

  1522.           <td></td>

  1523.           <td>)</td>

  1524.           <td></td><td></td>

  1525.         </tr>

  1526.       </table>

  1527.   </td>

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

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

  1530.   </tr>

  1531. </table>

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

  1533. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>

  1534.   <table class="params">

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

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

  1537.   </table>

  1538.   </dd>

  1539. </dl>

  1540. 

  1541. </div>

  1542. </div>

  1543. <a class="anchor" id="a2a1e4cc8056ba23b55dfa2c6486b8798"></a>

  1544. <div class="memitem">

  1545. <div class="memproto">

  1546. <table class="mlabels">

  1547.   <tr>

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

  1549.       <table class="memname">

  1550.         <tr>

  1551.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorHalt </td>

  1552.           <td>(</td>

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

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

  1555.           <td></td>

  1556.         </tr>

  1557.       </table>

  1558.   </td>

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

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

  1561.   </tr>

  1562. </table>

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

  1564. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>

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

  1566.   <table class="params">

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

  1568.   </table>

  1569.   </dd>

  1570. </dl>

  1571. 

  1572. </div>

  1573. </div>

  1574. <a class="anchor" id="ab03d98012dea18733c3252f27832de69"></a>

  1575. <div class="memitem">

  1576. <div class="memproto">

  1577. <table class="mlabels">

  1578.   <tr>

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

  1580.       <table class="memname">

  1581.         <tr>

  1582.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorHalt </td>

  1583.           <td>(</td>

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

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

  1586.         </tr>

  1587.         <tr>

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

  1589.           <td></td>

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

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

  1592.         </tr>

  1593.         <tr>

  1594.           <td></td>

  1595.           <td>)</td>

  1596.           <td></td><td></td>

  1597.         </tr>

  1598.       </table>

  1599.   </td>

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

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

  1602.   </tr>

  1603. </table>

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

  1605. <p>Print message, error details, and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p><dl class="params"><dt>Parameters</dt><dd>

  1606.   <table class="params">

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

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

  1609.   </table>

  1610.   </dd>

  1611. </dl>

  1612. 

  1613. </div>

  1614. </div>

  1615. <a class="anchor" id="ae31c9cbd7e1c03129d6c99b25f73cd50"></a>

  1616. <div class="memitem">

  1617. <div class="memproto">

  1618. <table class="mlabels">

  1619.   <tr>

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

  1621.       <table class="memname">

  1622.         <tr>

  1623.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorPrint </td>

  1624.           <td>(</td>

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

  1626.           <td></td>

  1627.         </tr>

  1628.       </table>

  1629.   </td>

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

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

  1632.   </tr>

  1633. </table>

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

  1635. <p>Print error details after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails. </p>

  1636. 

  1637. </div>

  1638. </div>

  1639. <a class="anchor" id="a066707dce0667213b5f083d59f67448d"></a>

  1640. <div class="memitem">

  1641. <div class="memproto">

  1642. <table class="mlabels">

  1643.   <tr>

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

  1645.       <table class="memname">

  1646.         <tr>

  1647.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorPrint </td>

  1648.           <td>(</td>

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

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

  1651.           <td></td>

  1652.         </tr>

  1653.       </table>

  1654.   </td>

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

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

  1657.   </tr>

  1658. </table>

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

  1660. <p>Print error details after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>

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

  1662.   <table class="params">

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

  1664.   </table>

  1665.   </dd>

  1666. </dl>

  1667. 

  1668. </div>

  1669. </div>

  1670. <a class="anchor" id="a538796f79fd9db9c5bbeefd9defe639a"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorPrint </td>

  1679.           <td>(</td>

  1680.           <td class="paramtype">char const *&#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_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</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="ad9855d33ebd465715b706d0926291b13"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorPrint </td>

  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">char const *&#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">inline</span><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_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</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="ad6ffec5a7d82be46d46b8a4f82d0803b"></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 <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorPrint </td>

  1752.           <td>(</td>

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

  1754.           <td class="paramname"><em>msg</em></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>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>

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

  1766.   <table class="params">

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

  1768.   </table>

  1769.   </dd>

  1770. </dl>

  1771. 

  1772. </div>

  1773. </div>

  1774. <a class="anchor" id="a8a2018b6366145a9843d3d29a47d6560"></a>

  1775. <div class="memitem">

  1776. <div class="memproto">

  1777. <table class="mlabels">

  1778.   <tr>

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

  1780.       <table class="memname">

  1781.         <tr>

  1782.           <td class="memname">void <a class="el" href="class_sd_file_system.html">SdFileSystem</a>&lt; <a class="el" href="class_sd_spi_card.html">SdSpiCard</a>  &gt;::initErrorPrint </td>

  1783.           <td>(</td>

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

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

  1786.         </tr>

  1787.         <tr>

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

  1789.           <td></td>

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

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

  1792.         </tr>

  1793.         <tr>

  1794.           <td></td>

  1795.           <td>)</td>

  1796.           <td></td><td></td>

  1797.         </tr>

  1798.       </table>

  1799.   </td>

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

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

  1802.   </tr>

  1803. </table>

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

  1805. <p>Print message and error details and halt after <a class="el" href="class_sd_file_system.html#ad94237ef45c52698e97b04e8c131f21e">begin()</a> fails.</p>

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

  1807.   <table class="params">

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

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

  1810.   </table>

  1811.   </dd>

  1812. </dl>

  1813. 

  1814. </div>

  1815. </div>

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

  1817. <div class="memitem">

  1818. <div class="memproto">

  1819. <table class="mlabels">

  1820.   <tr>

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

  1822.       <table class="memname">

  1823.         <tr>

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

  1825.           <td>(</td>

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

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

  1828.           <td></td>

  1829.         </tr>

  1830.       </table>

  1831.   </td>

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

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

  1834.   </tr>

  1835. </table>

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

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

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

  1839.   <table class="params">

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

  1841.   </table>

  1842.   </dd>

  1843. </dl>

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

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

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

  1847. 

  1848. </div>

  1849. </div>

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

  1851. <div class="memitem">

  1852. <div class="memproto">

  1853. <table class="mlabels">

  1854.   <tr>

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

  1856.       <table class="memname">

  1857.         <tr>

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

  1859.           <td>(</td>

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

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

  1862.         </tr>

  1863.         <tr>

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

  1865.           <td></td>

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

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

  1868.         </tr>

  1869.         <tr>

  1870.           <td></td>

  1871.           <td>)</td>

  1872.           <td></td><td></td>

  1873.         </tr>

  1874.       </table>

  1875.   </td>

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

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

  1878.   </tr>

  1879. </table>

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

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

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

  1883.   <table class="params">

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

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

  1886.   </table>

  1887.   </dd>

  1888. </dl>

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

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

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

  1892. 

  1893. </div>

  1894. </div>

  1895. <a class="anchor" id="ae12fb8bfad5c4a8e052dda70a5a0ed93"></a>

  1896. <div class="memitem">

  1897. <div class="memproto">

  1898. <table class="mlabels">

  1899.   <tr>

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

  1901.       <table class="memname">

  1902.         <tr>

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

  1904.           <td>(</td>

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

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

  1907.         </tr>

  1908.         <tr>

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

  1910.           <td></td>

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

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

  1913.         </tr>

  1914.         <tr>

  1915.           <td></td>

  1916.           <td>)</td>

  1917.           <td></td><td></td>

  1918.         </tr>

  1919.       </table>

  1920.   </td>

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

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

  1923.   </tr>

  1924. </table>

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

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

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

  1928.   <table class="params">

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

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

  1931.   </table>

  1932.   </dd>

  1933. </dl>

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

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

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

  1937. 

  1938. </div>

  1939. </div>

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

  1941. <div class="memitem">

  1942. <div class="memproto">

  1943. <table class="mlabels">

  1944.   <tr>

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

  1946.       <table class="memname">

  1947.         <tr>

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

  1949.           <td>(</td>

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

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

  1952.         </tr>

  1953.         <tr>

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

  1955.           <td></td>

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

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

  1958.         </tr>

  1959.         <tr>

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

  1961.           <td></td>

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

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

  1964.         </tr>

  1965.         <tr>

  1966.           <td></td>

  1967.           <td>)</td>

  1968.           <td></td><td></td>

  1969.         </tr>

  1970.       </table>

  1971.   </td>

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

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

  1974.   </tr>

  1975. </table>

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

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

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

  1979.   <table class="params">

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

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

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

  1983.   </table>

  1984.   </dd>

  1985. </dl>

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

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

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

  1989. 

  1990. </div>

  1991. </div>

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

  1993. <div class="memitem">

  1994. <div class="memproto">

  1995. <table class="mlabels">

  1996.   <tr>

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

  1998.       <table class="memname">

  1999.         <tr>

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

  2001.           <td>(</td>

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

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

  2004.         </tr>

  2005.         <tr>

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

  2007.           <td></td>

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

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

  2010.         </tr>

  2011.         <tr>

  2012.           <td></td>

  2013.           <td>)</td>

  2014.           <td></td><td></td>

  2015.         </tr>

  2016.       </table>

  2017.   </td>

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

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

  2020.   </tr>

  2021. </table>

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

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

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

  2025.   <table class="params">

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

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

  2028.   </table>

  2029.   </dd>

  2030. </dl>

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

  2032. 

  2033. </div>

  2034. </div>

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

  2036. <div class="memitem">

  2037. <div class="memproto">

  2038. <table class="mlabels">

  2039.   <tr>

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

  2041.       <table class="memname">

  2042.         <tr>

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

  2044.           <td>(</td>

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

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

  2047.         </tr>

  2048.         <tr>

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

  2050.           <td></td>

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

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

  2053.         </tr>

  2054.         <tr>

  2055.           <td></td>

  2056.           <td>)</td>

  2057.           <td></td><td></td>

  2058.         </tr>

  2059.       </table>

  2060.   </td>

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

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

  2063.   </tr>

  2064. </table>

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

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

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

  2068.   <table class="params">

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

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

  2071.   </table>

  2072.   </dd>

  2073. </dl>

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

  2075. 

  2076. </div>

  2077. </div>

  2078. <a class="anchor" id="a0abfb1f754a8fb559cfa884ee040f56f"></a>

  2079. <div class="memitem">

  2080. <div class="memproto">

  2081. <table class="mlabels">

  2082.   <tr>

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

  2084.       <table class="memname">

  2085.         <tr>

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

  2087.           <td>(</td>

  2088.           <td class="paramtype">const String &amp;&#160;</td>

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

  2090.         </tr>

  2091.         <tr>

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

  2093.           <td></td>

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

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

  2096.         </tr>

  2097.         <tr>

  2098.           <td></td>

  2099.           <td>)</td>

  2100.           <td></td><td></td>

  2101.         </tr>

  2102.       </table>

  2103.   </td>

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

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

  2106.   </tr>

  2107. </table>

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

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

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

  2111.   <table class="params">

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

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

  2114.   </table>

  2115.   </dd>

  2116. </dl>

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

  2118. 

  2119. </div>

  2120. </div>

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

  2122. <div class="memitem">

  2123. <div class="memproto">

  2124. <table class="mlabels">

  2125.   <tr>

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

  2127.       <table class="memname">

  2128.         <tr>

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

  2130.           <td>(</td>

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

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

  2133.           <td></td>

  2134.         </tr>

  2135.       </table>

  2136.   </td>

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

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

  2139.   </tr>

  2140. </table>

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

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

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

  2144.   <table class="params">

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

  2146.   </table>

  2147.   </dd>

  2148. </dl>

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

  2150. 

  2151. </div>

  2152. </div>

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

  2154. <div class="memitem">

  2155. <div class="memproto">

  2156. <table class="mlabels">

  2157.   <tr>

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

  2159.       <table class="memname">

  2160.         <tr>

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

  2162.           <td>(</td>

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

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

  2165.         </tr>

  2166.         <tr>

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

  2168.           <td></td>

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

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

  2171.         </tr>

  2172.         <tr>

  2173.           <td></td>

  2174.           <td>)</td>

  2175.           <td></td><td></td>

  2176.         </tr>

  2177.       </table>

  2178.   </td>

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

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

  2181.   </tr>

  2182. </table>

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

  2184. <p>Rename a file or subdirectory.</p>

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

  2186.   <table class="params">

  2187.     <tr><td class="paramdir">[in]</td><td class="paramname">oldPath</td><td>Path name to the file or subdirectory to be renamed.</td></tr>

  2188.     <tr><td class="paramdir">[in]</td><td class="paramname">newPath</td><td>New path name of the file or subdirectory.</td></tr>

  2189.   </table>

  2190.   </dd>

  2191. </dl>

  2192. <p>The <em>newPath</em> object must not exist before the rename call.</p>

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

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

  2195. 

  2196. </div>

  2197. </div>

  2198. <a class="anchor" id="aaed2edc7ff7fedb163458c870bb41b33"></a>

  2199. <div class="memitem">

  2200. <div class="memproto">

  2201. <table class="mlabels">

  2202.   <tr>

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

  2204.       <table class="memname">

  2205.         <tr>

  2206.           <td class="memname">bool FatFileSystem::rmdir </td>

  2207.           <td>(</td>

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

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

  2210.           <td></td>

  2211.         </tr>

  2212.       </table>

  2213.   </td>

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

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

  2216.   </tr>

  2217. </table>

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

  2219. <p>Remove a subdirectory from the volume's working directory.</p>

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

  2221.   <table class="params">

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

  2223.   </table>

  2224.   </dd>

  2225. </dl>

  2226. <p>The subdirectory file will be removed only if it is empty.</p>

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

  2228. 

  2229. </div>

  2230. </div>

  2231. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>

  2232. <div class="memitem">

  2233. <div class="memproto">

  2234. <table class="mlabels">

  2235.   <tr>

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

  2237.       <table class="memname">

  2238.         <tr>

  2239.           <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>

  2240.           <td>(</td>

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

  2242.           <td> const</td>

  2243.         </tr>

  2244.       </table>

  2245.   </td>

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

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

  2248.   </tr>

  2249. </table>

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

  2251. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>

  2252. 

  2253. </div>

  2254. </div>

  2255. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>

  2256. <div class="memitem">

  2257. <div class="memproto">

  2258. <table class="mlabels">

  2259.   <tr>

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

  2261.       <table class="memname">

  2262.         <tr>

  2263.           <td class="memname">uint32_t FatVolume::rootDirStart </td>

  2264.           <td>(</td>

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

  2266.           <td> const</td>

  2267.         </tr>

  2268.       </table>

  2269.   </td>

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

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

  2272.   </tr>

  2273. </table>

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

  2275. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>

  2276. 

  2277. </div>

  2278. </div>

  2279. <a class="anchor" id="ad60cb13557f35578f868e03e9ccb8be1"></a>

  2280. <div class="memitem">

  2281. <div class="memproto">

  2282. <table class="mlabels">

  2283.   <tr>

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

  2285.       <table class="memname">

  2286.         <tr>

  2287.           <td class="memname">bool FatFileSystem::truncate </td>

  2288.           <td>(</td>

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

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

  2291.         </tr>

  2292.         <tr>

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

  2294.           <td></td>

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

  2296.           <td class="paramname"><em>length</em>&#160;</td>

  2297.         </tr>

  2298.         <tr>

  2299.           <td></td>

  2300.           <td>)</td>

  2301.           <td></td><td></td>

  2302.         </tr>

  2303.       </table>

  2304.   </td>

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

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

  2307.   </tr>

  2308. </table>

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

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

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

  2312.   <table class="params">

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

  2314.     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The desired length for the file.</td></tr>

  2315.   </table>

  2316.   </dd>

  2317. </dl>

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

  2319. 

  2320. </div>

  2321. </div>

  2322. <a class="anchor" id="a4ca68fe47bb675df0a80df1ed7a53698"></a>

  2323. <div class="memitem">

  2324. <div class="memproto">

  2325. <table class="mlabels">

  2326.   <tr>

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

  2328.       <table class="memname">

  2329.         <tr>

  2330.           <td class="memname"><a class="el" href="class_fat_volume.html">FatVolume</a>* FatFileSystem::vol </td>

  2331.           <td>(</td>

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

  2333.           <td></td>

  2334.         </tr>

  2335.       </table>

  2336.   </td>

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

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

  2339.   </tr>

  2340. </table>

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

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

  2343. 

  2344. </div>

  2345. </div>

  2346. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>

  2347. <div class="memitem">

  2348. <div class="memproto">

  2349. <table class="mlabels">

  2350.   <tr>

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

  2352.       <table class="memname">

  2353.         <tr>

  2354.           <td class="memname">uint32_t FatVolume::volumeBlockCount </td>

  2355.           <td>(</td>

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

  2357.           <td> const</td>

  2358.         </tr>

  2359.       </table>

  2360.   </td>

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

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

  2363.   </tr>

  2364. </table>

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

  2366. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>

  2367. 

  2368. </div>

  2369. </div>

  2370. <a class="anchor" id="acf257d02b7166683bda2abc5058004bf"></a>

  2371. <div class="memitem">

  2372. <div class="memproto">

  2373. <table class="mlabels">

  2374.   <tr>

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

  2376.       <table class="memname">

  2377.         <tr>

  2378.           <td class="memname"><a class="el" href="class_fat_file.html">FatFile</a>* FatFileSystem::vwd </td>

  2379.           <td>(</td>

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

  2381.           <td></td>

  2382.         </tr>

  2383.       </table>

  2384.   </td>

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

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

  2387.   </tr>

  2388. </table>

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

  2390. <dl class="section return"><dt>Returns</dt><dd>a pointer to the volume working directory. </dd></dl>

  2391. 

  2392. </div>

  2393. </div>

  2394. <a class="anchor" id="a36d7831f92acfbfef1c4a24dd7103dc4"></a>

  2395. <div class="memitem">

  2396. <div class="memproto">

  2397. <table class="mlabels">

  2398.   <tr>

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

  2400.       <table class="memname">

  2401.         <tr>

  2402.           <td class="memname">bool FatFileSystem::wipe </td>

  2403.           <td>(</td>

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

  2405.           <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>

  2406.           <td></td>

  2407.         </tr>

  2408.       </table>

  2409.   </td>

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

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

  2412.   </tr>

  2413. </table>

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

  2415. <p>Wipe all data from the volume. You must reinitialize the volume before accessing it again. </p><dl class="params"><dt>Parameters</dt><dd>

  2416.   <table class="params">

  2417.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>

  2418.   </table>

  2419.   </dd>

  2420. </dl>

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

  2422. 

  2423. </div>

  2424. </div>

  2425. <hr/>The documentation for this class was generated from the following file:<ul>

  2426. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_fat_8h.html">SdFat.h</a></li>

  2427. </ul>

  2428. </div><!-- contents -->

  2429. <!-- start footer part -->

  2430. <hr class="footer"/><address class="footer"><small>

  2431. Generated on Mon Sep 5 2016 10:18:53 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  2432. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2433. </a> 1.8.10

  2434. </small></address>

  2435. </body>

  2436. </html>