visus
/
teensy-sdfat
Sledovat 1
Oblíbit 0
Rozštěpit 0
Zdrojový kód Úkoly 0 Požadavky na natažení 0 Vydání 0 Wiki Aktivita
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
33 Revize
1 Větev
Strom: 1c74e428dd
Větve Značky
${ item.name }
Vytvořit větev ${ searchTerm }
z „1c74e428dd“
${ noResults }
teensy-sdfat/html/class_fat_volume.html

625 lines
28KB
Surový Blame Historie 

  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 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="#friends">Friends</a> &#124;

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

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

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for FatVolume:</div>

  99. <div class="dyncontent">

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

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

  102. <area shape="rect" id="node2" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="139,64,245,91"/>

  103. <area shape="rect" id="node3" href="class_sd_file_system.html" title="Virtual base class for SdFat library. " alt="" coords="301,13,511,40"/>

  104. <area shape="rect" id="node4" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdBlockDriver \&gt;" alt="" coords="301,64,511,91"/>

  105. <area shape="rect" id="node7" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdBlockDriverEX \&gt;" alt="" coords="293,123,519,149"/>

  106. <area shape="rect" id="node5" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="627,5,685,32"/>

  107. <area shape="rect" id="node6" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="575,57,737,98"/>

  108. <area shape="rect" id="node8" href="class_sd_fat_e_x.html" title="SdFat class with extended SD I/O. " alt="" coords="619,123,693,149"/>

  109. <area shape="rect" id="node9" href="class_sd_fat_soft_spi_e_x.html" title="SdFat class using software SPI and extended SD I/O. " alt="" coords="567,174,745,215"/>

  110. </map>

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

  112. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  163. </table>

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

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

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

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

  168. <div class="memitem">

  169. <div class="memproto">

  170. <table class="mlabels">

  171.   <tr>

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

  173.       <table class="memname">

  174.         <tr>

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

  176.           <td>(</td>

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

  178.           <td></td>

  179.         </tr>

  180.       </table>

  181.   </td>

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

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

  184.   </tr>

  185. </table>

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

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

  188. 

  189. </div>

  190. </div>

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

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

  193. <div class="memitem">

  194. <div class="memproto">

  195. <table class="mlabels">

  196.   <tr>

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

  198.       <table class="memname">

  199.         <tr>

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

  201.           <td>(</td>

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

  203.           <td> const</td>

  204.         </tr>

  205.       </table>

  206.   </td>

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

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

  209.   </tr>

  210. </table>

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

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

  213. 

  214. </div>

  215. </div>

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

  217. <div class="memitem">

  218. <div class="memproto">

  219. <table class="mlabels">

  220.   <tr>

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

  222.       <table class="memname">

  223.         <tr>

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

  225.           <td>(</td>

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

  227.           <td> const</td>

  228.         </tr>

  229.       </table>

  230.   </td>

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

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

  233.   </tr>

  234. </table>

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

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

  237. 

  238. </div>

  239. </div>

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

  241. <div class="memitem">

  242. <div class="memproto">

  243. <table class="mlabels">

  244.   <tr>

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

  246.       <table class="memname">

  247.         <tr>

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

  249.           <td>(</td>

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

  251.           <td></td>

  252.         </tr>

  253.       </table>

  254.   </td>

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

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

  257.   </tr>

  258. </table>

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

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

  261. 

  262. </div>

  263. </div>

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

  265. <div class="memitem">

  266. <div class="memproto">

  267. <table class="mlabels">

  268.   <tr>

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

  270.       <table class="memname">

  271.         <tr>

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

  273.           <td>(</td>

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

  275.           <td> const</td>

  276.         </tr>

  277.       </table>

  278.   </td>

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

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

  281.   </tr>

  282. </table>

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

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

  285. 

  286. </div>

  287. </div>

  288. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></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">uint8_t FatVolume::clusterSizeShift </td>

  297.           <td>(</td>

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

  299.           <td> const</td>

  300.         </tr>

  301.       </table>

  302.   </td>

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

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

  305.   </tr>

  306. </table>

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

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

  309. 

  310. </div>

  311. </div>

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

  313. <div class="memitem">

  314. <div class="memproto">

  315. <table class="mlabels">

  316.   <tr>

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

  318.       <table class="memname">

  319.         <tr>

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

  321.           <td>(</td>

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

  323.           <td> const</td>

  324.         </tr>

  325.       </table>

  326.   </td>

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

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

  329.   </tr>

  330. </table>

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

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

  333. 

  334. </div>

  335. </div>

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

  337. <div class="memitem">

  338. <div class="memproto">

  339. <table class="mlabels">

  340.   <tr>

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

  342.       <table class="memname">

  343.         <tr>

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

  345.           <td>(</td>

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

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

  348.         </tr>

  349.         <tr>

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

  351.           <td></td>

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

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

  354.         </tr>

  355.         <tr>

  356.           <td></td>

  357.           <td>)</td>

  358.           <td></td><td></td>

  359.         </tr>

  360.       </table>

  361.   </td>

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

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

  364.   </tr>

  365. </table>

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

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

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

  369.   <table class="params">

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

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

  372.   </table>

  373.   </dd>

  374. </dl>

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

  376. 

  377. </div>

  378. </div>

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

  380. <div class="memitem">

  381. <div class="memproto">

  382. <table class="mlabels">

  383.   <tr>

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

  385.       <table class="memname">

  386.         <tr>

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

  388.           <td>(</td>

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

  390.           <td></td>

  391.         </tr>

  392.       </table>

  393.   </td>

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

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

  396.   </tr>

  397. </table>

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

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

  400. 

  401. </div>

  402. </div>

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

  404. <div class="memitem">

  405. <div class="memproto">

  406. <table class="mlabels">

  407.   <tr>

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

  409.       <table class="memname">

  410.         <tr>

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

  412.           <td>(</td>

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

  414.           <td> const</td>

  415.         </tr>

  416.       </table>

  417.   </td>

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

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

  420.   </tr>

  421. </table>

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

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

  424. 

  425. </div>

  426. </div>

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

  428. <div class="memitem">

  429. <div class="memproto">

  430. <table class="mlabels">

  431.   <tr>

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

  433.       <table class="memname">

  434.         <tr>

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

  436.           <td>(</td>

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

  438.           <td> const</td>

  439.         </tr>

  440.       </table>

  441.   </td>

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

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

  444.   </tr>

  445. </table>

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

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

  448. 

  449. </div>

  450. </div>

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

  452. <div class="memitem">

  453. <div class="memproto">

  454.       <table class="memname">

  455.         <tr>

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

  457.           <td>(</td>

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

  459.           <td></td>

  460.         </tr>

  461.       </table>

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

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

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

  465. 

  466. </div>

  467. </div>

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

  469. <div class="memitem">

  470. <div class="memproto">

  471. <table class="mlabels">

  472.   <tr>

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

  474.       <table class="memname">

  475.         <tr>

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

  477.           <td>(</td>

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

  479.           <td></td>

  480.         </tr>

  481.       </table>

  482.   </td>

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

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

  485.   </tr>

  486. </table>

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

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

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

  490. 

  491. </div>

  492. </div>

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

  494. <div class="memitem">

  495. <div class="memproto">

  496.       <table class="memname">

  497.         <tr>

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

  499.           <td>(</td>

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

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

  502.           <td></td>

  503.         </tr>

  504.       </table>

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

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

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

  508.   <table class="params">

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

  510.   </table>

  511.   </dd>

  512. </dl>

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

  514. 

  515. </div>

  516. </div>

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

  518. <div class="memitem">

  519. <div class="memproto">

  520. <table class="mlabels">

  521.   <tr>

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

  523.       <table class="memname">

  524.         <tr>

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

  526.           <td>(</td>

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

  528.           <td> const</td>

  529.         </tr>

  530.       </table>

  531.   </td>

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

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

  534.   </tr>

  535. </table>

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

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

  538. 

  539. </div>

  540. </div>

  541. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>

  542. <div class="memitem">

  543. <div class="memproto">

  544. <table class="mlabels">

  545.   <tr>

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

  547.       <table class="memname">

  548.         <tr>

  549.           <td class="memname">uint32_t FatVolume::rootDirStart </td>

  550.           <td>(</td>

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

  552.           <td> const</td>

  553.         </tr>

  554.       </table>

  555.   </td>

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

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

  558.   </tr>

  559. </table>

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

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

  562. 

  563. </div>

  564. </div>

  565. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>

  566. <div class="memitem">

  567. <div class="memproto">

  568. <table class="mlabels">

  569.   <tr>

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

  571.       <table class="memname">

  572.         <tr>

  573.           <td class="memname">uint32_t FatVolume::volumeBlockCount </td>

  574.           <td>(</td>

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

  576.           <td> const</td>

  577.         </tr>

  578.       </table>

  579.   </td>

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

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

  582.   </tr>

  583. </table>

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

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

  586. 

  587. </div>

  588. </div>

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

  590. <div class="memitem">

  591. <div class="memproto">

  592.       <table class="memname">

  593.         <tr>

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

  595.           <td>(</td>

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

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

  598.           <td></td>

  599.         </tr>

  600.       </table>

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

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

  603.   <table class="params">

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

  605.   </table>

  606.   </dd>

  607. </dl>

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

  609. 

  610. </div>

  611. </div>

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

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

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

  615. </ul>

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

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

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

  619. Generated on Fri Aug 19 2016 08:28:00 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  621. </a> 1.8.10

  622. </small></address>

  623. </body>

  624. </html>