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.
27 Commits
1 Branch
Tree: 49127b29b6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '49127b29b6'
${ noResults }
teensy-sdfat/html/class_fat_volume.html

620 lines
27KB
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: FatVolume Class Reference</title>

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

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

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

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

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

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

  26.    <div id="projectname">SdFat

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

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

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

  67.     </ul>

  68.   </div>

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

  70. <div id="MSearchSelectWindow"

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

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

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

  74. </div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

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

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

  87. <a href="#friends">Friends</a> &#124;

  88. <a href="class_fat_volume-members.html">List of all members</a>  </div>

  89.   <div class="headertitle">

  90. <div class="title">FatVolume Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

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

  92. <div class="contents">

  93. 

  94. <p>Access FAT16 and FAT32 volumes on raw file devices.  

  95.  <a href="class_fat_volume.html#details">More...</a></p>

  96. 

  97. <p><code>#include &lt;FatVolume.h&gt;</code></p>

  98. <div class="dynheader">

  99. Inheritance diagram for FatVolume:</div>

  100. <div class="dyncontent">

  101. <div class="center"><img src="class_fat_volume__inherit__graph.png" border="0" usemap="#_fat_volume_inherit__map" alt="Inheritance graph"/></div>

  102. <map name="_fat_volume_inherit__map" id="_fat_volume_inherit__map">

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

  104. <area shape="rect" id="node3" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="91,155,177,181"/>

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

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

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

  108. </map>

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

  110. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  147. <tr class="memitem:a8088aa74cf601996905dadd2eea6966c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a8088aa74cf601996905dadd2eea6966c">wipe</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=0)</td></tr>

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

  149. </table><table class="memberdecls">

  150. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  151. Friends</h2></td></tr>

  152. <tr class="memitem:a1e97a7aed860b898c403cb29455b3fe7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e97a7aed860b898c403cb29455b3fe7"></a>

  153. class&#160;</td><td class="memItemRight" valign="bottom"><b>FatCache</b></td></tr>

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

  155. <tr class="memitem:a18fb15a715ea85037ab802286853103e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18fb15a715ea85037ab802286853103e"></a>

  156. class&#160;</td><td class="memItemRight" valign="bottom"><b>FatFile</b></td></tr>

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

  158. </table>

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

  160. <div class="textblock"><p>Access FAT16 and FAT32 volumes on raw file devices. </p>

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

  162. <a class="anchor" id="a026de2bb58026e4edea130db2949b84c"></a>

  163. <div class="memitem">

  164. <div class="memproto">

  165. <table class="mlabels">

  166.   <tr>

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

  168.       <table class="memname">

  169.         <tr>

  170.           <td class="memname">FatVolume::FatVolume </td>

  171.           <td>(</td>

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

  173.           <td></td>

  174.         </tr>

  175.       </table>

  176.   </td>

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

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

  179.   </tr>

  180. </table>

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

  182. <p>Create an instance of <a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> </p>

  183. 

  184. </div>

  185. </div>

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

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

  188. <div class="memitem">

  189. <div class="memproto">

  190. <table class="mlabels">

  191.   <tr>

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

  193.       <table class="memname">

  194.         <tr>

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

  196.           <td>(</td>

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

  198.           <td> const</td>

  199.         </tr>

  200.       </table>

  201.   </td>

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

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

  204.   </tr>

  205. </table>

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

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

  208. 

  209. </div>

  210. </div>

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

  212. <div class="memitem">

  213. <div class="memproto">

  214. <table class="mlabels">

  215.   <tr>

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

  217.       <table class="memname">

  218.         <tr>

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

  220.           <td>(</td>

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

  222.           <td> const</td>

  223.         </tr>

  224.       </table>

  225.   </td>

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

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

  228.   </tr>

  229. </table>

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

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

  232. 

  233. </div>

  234. </div>

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

  236. <div class="memitem">

  237. <div class="memproto">

  238. <table class="mlabels">

  239.   <tr>

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

  241.       <table class="memname">

  242.         <tr>

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

  244.           <td>(</td>

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

  246.           <td></td>

  247.         </tr>

  248.       </table>

  249.   </td>

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

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

  252.   </tr>

  253. </table>

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

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

  256. 

  257. </div>

  258. </div>

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

  260. <div class="memitem">

  261. <div class="memproto">

  262. <table class="mlabels">

  263.   <tr>

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

  265.       <table class="memname">

  266.         <tr>

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

  268.           <td>(</td>

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

  270.           <td> const</td>

  271.         </tr>

  272.       </table>

  273.   </td>

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

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

  276.   </tr>

  277. </table>

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

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

  280. 

  281. </div>

  282. </div>

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

  284. <div class="memitem">

  285. <div class="memproto">

  286. <table class="mlabels">

  287.   <tr>

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

  289.       <table class="memname">

  290.         <tr>

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

  292.           <td>(</td>

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

  294.           <td> const</td>

  295.         </tr>

  296.       </table>

  297.   </td>

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

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

  300.   </tr>

  301. </table>

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

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

  304. 

  305. </div>

  306. </div>

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

  308. <div class="memitem">

  309. <div class="memproto">

  310. <table class="mlabels">

  311.   <tr>

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

  313.       <table class="memname">

  314.         <tr>

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

  316.           <td>(</td>

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

  318.           <td> const</td>

  319.         </tr>

  320.       </table>

  321.   </td>

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

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

  324.   </tr>

  325. </table>

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

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

  328. 

  329. </div>

  330. </div>

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

  332. <div class="memitem">

  333. <div class="memproto">

  334. <table class="mlabels">

  335.   <tr>

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

  337.       <table class="memname">

  338.         <tr>

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

  340.           <td>(</td>

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

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

  343.         </tr>

  344.         <tr>

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

  346.           <td></td>

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

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

  349.         </tr>

  350.         <tr>

  351.           <td></td>

  352.           <td>)</td>

  353.           <td></td><td></td>

  354.         </tr>

  355.       </table>

  356.   </td>

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

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

  359.   </tr>

  360. </table>

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

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

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

  364.   <table class="params">

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

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

  367.   </table>

  368.   </dd>

  369. </dl>

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

  371. 

  372. </div>

  373. </div>

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

  375. <div class="memitem">

  376. <div class="memproto">

  377. <table class="mlabels">

  378.   <tr>

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

  380.       <table class="memname">

  381.         <tr>

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

  383.           <td>(</td>

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

  385.           <td></td>

  386.         </tr>

  387.       </table>

  388.   </td>

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

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

  391.   </tr>

  392. </table>

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

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

  395. 

  396. </div>

  397. </div>

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

  399. <div class="memitem">

  400. <div class="memproto">

  401. <table class="mlabels">

  402.   <tr>

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

  404.       <table class="memname">

  405.         <tr>

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

  407.           <td>(</td>

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

  409.           <td> const</td>

  410.         </tr>

  411.       </table>

  412.   </td>

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

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

  415.   </tr>

  416. </table>

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

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

  419. 

  420. </div>

  421. </div>

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

  423. <div class="memitem">

  424. <div class="memproto">

  425. <table class="mlabels">

  426.   <tr>

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

  428.       <table class="memname">

  429.         <tr>

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

  431.           <td>(</td>

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

  433.           <td> const</td>

  434.         </tr>

  435.       </table>

  436.   </td>

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

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

  439.   </tr>

  440. </table>

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

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

  443. 

  444. </div>

  445. </div>

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

  447. <div class="memitem">

  448. <div class="memproto">

  449.       <table class="memname">

  450.         <tr>

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

  452.           <td>(</td>

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

  454.           <td></td>

  455.         </tr>

  456.       </table>

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

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

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

  460. 

  461. </div>

  462. </div>

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

  464. <div class="memitem">

  465. <div class="memproto">

  466. <table class="mlabels">

  467.   <tr>

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

  469.       <table class="memname">

  470.         <tr>

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

  472.           <td>(</td>

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

  474.           <td></td>

  475.         </tr>

  476.       </table>

  477.   </td>

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

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

  480.   </tr>

  481. </table>

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

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

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

  485. 

  486. </div>

  487. </div>

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

  489. <div class="memitem">

  490. <div class="memproto">

  491.       <table class="memname">

  492.         <tr>

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

  494.           <td>(</td>

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

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

  497.           <td></td>

  498.         </tr>

  499.       </table>

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

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

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

  503.   <table class="params">

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

  505.   </table>

  506.   </dd>

  507. </dl>

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

  509. 

  510. </div>

  511. </div>

  512. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>

  513. <div class="memitem">

  514. <div class="memproto">

  515. <table class="mlabels">

  516.   <tr>

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

  518.       <table class="memname">

  519.         <tr>

  520.           <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>

  521.           <td>(</td>

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

  523.           <td> const</td>

  524.         </tr>

  525.       </table>

  526.   </td>

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

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

  529.   </tr>

  530. </table>

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

  532. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>

  533. 

  534. </div>

  535. </div>

  536. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></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">uint32_t FatVolume::rootDirStart </td>

  545.           <td>(</td>

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

  547.           <td> const</td>

  548.         </tr>

  549.       </table>

  550.   </td>

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

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

  553.   </tr>

  554. </table>

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

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

  557. 

  558. </div>

  559. </div>

  560. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></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 FatVolume::volumeBlockCount </td>

  569.           <td>(</td>

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

  571.           <td> const</td>

  572.         </tr>

  573.       </table>

  574.   </td>

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

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

  577.   </tr>

  578. </table>

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

  580. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>

  581. 

  582. </div>

  583. </div>

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

  585. <div class="memitem">

  586. <div class="memproto">

  587.       <table class="memname">

  588.         <tr>

  589.           <td class="memname">bool FatVolume::wipe </td>

  590.           <td>(</td>

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

  592.           <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>

  593.           <td></td>

  594.         </tr>

  595.       </table>

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

  597. <p>Wipe all data from the volume. </p><dl class="params"><dt>Parameters</dt><dd>

  598.   <table class="params">

  599.     <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>

  600.   </table>

  601.   </dd>

  602. </dl>

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

  604. 

  605. </div>

  606. </div>

  607. <hr/>The documentation for this class was generated from the following files:<ul>

  608. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_volume_8h.html">FatVolume.h</a></li>

  609. <li>Arduino/libraries/SdFat/src/FatLib/FatVolume.cpp</li>

  610. </ul>

  611. </div><!-- contents -->

  612. <!-- start footer part -->

  613. <hr class="footer"/><address class="footer"><small>

  614. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  615. <img class="footer" src="doxygen.png" alt="doxygen"/>

  616. </a> 1.8.10

  617. </small></address>

  618. </body>

  619. </html>