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

614 lines
28KB
Brut Annotations Historique 

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

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

  3. <head>

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

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

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

  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/search.js"></script>

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

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">SdFat

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

  33. <!-- Generated by Doxygen 1.8.8 -->

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

  40.       <li><a href="modules.html"><span>Modules</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. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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<span class="mlabels"><span class="mlabel">abstract</span></span></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="node3" href="class_fat_file_system.html" title="Integration class for the FatLib library. " alt="" coords="80,80,187,107"/>
<area shape="rect" id="node13" href="class_sd_volume.html" title="SdVolume Soon to be removed. " alt="" coords="211,80,293,107"/>
<area shape="rect" id="node5" href="class_sd_fat_base.html" title="Virtual base class for SdFat library. " alt="" coords="90,155,176,181"/>
<area shape="rect" id="node7" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="5,237,61,264"/>
<area shape="rect" id="node9" href="class_sd_fat_lib_spi.html" title="SdFat class using the standard Arduino SPI library. " alt="" coords="87,237,180,264"/>
<area shape="rect" id="node11" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="204,230,367,271"/>
</map>

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

  104. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  152. </table>

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

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

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

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

  157. <div class="memitem">

  158. <div class="memproto">

  159. <table class="mlabels">

  160.   <tr>

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

  162.       <table class="memname">

  163.         <tr>

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

  165.           <td>(</td>

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

  167.           <td></td>

  168.         </tr>

  169.       </table>

  170.   </td>

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

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

  173.   </tr>

  174. </table>

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

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

  177. 

  178. </div>

  179. </div>

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

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

  182. <div class="memitem">

  183. <div class="memproto">

  184. <table class="mlabels">

  185.   <tr>

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

  187.       <table class="memname">

  188.         <tr>

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

  190.           <td>(</td>

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

  192.           <td> const</td>

  193.         </tr>

  194.       </table>

  195.   </td>

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

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

  198.   </tr>

  199. </table>

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

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

  202. 

  203. </div>

  204. </div>

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

  206. <div class="memitem">

  207. <div class="memproto">

  208. <table class="mlabels">

  209.   <tr>

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

  211.       <table class="memname">

  212.         <tr>

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

  214.           <td>(</td>

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

  216.           <td> const</td>

  217.         </tr>

  218.       </table>

  219.   </td>

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

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

  222.   </tr>

  223. </table>

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

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

  226. 

  227. </div>

  228. </div>

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

  230. <div class="memitem">

  231. <div class="memproto">

  232. <table class="mlabels">

  233.   <tr>

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

  235.       <table class="memname">

  236.         <tr>

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

  238.           <td>(</td>

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

  240.           <td></td>

  241.         </tr>

  242.       </table>

  243.   </td>

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

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

  246.   </tr>

  247. </table>

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

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

  250. 

  251. </div>

  252. </div>

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

  254. <div class="memitem">

  255. <div class="memproto">

  256. <table class="mlabels">

  257.   <tr>

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

  259.       <table class="memname">

  260.         <tr>

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

  262.           <td>(</td>

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

  264.           <td> const</td>

  265.         </tr>

  266.       </table>

  267.   </td>

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

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

  270.   </tr>

  271. </table>

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

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

  274. 

  275. </div>

  276. </div>

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

  278. <div class="memitem">

  279. <div class="memproto">

  280. <table class="mlabels">

  281.   <tr>

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

  283.       <table class="memname">

  284.         <tr>

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

  286.           <td>(</td>

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

  288.           <td> const</td>

  289.         </tr>

  290.       </table>

  291.   </td>

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

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

  294.   </tr>

  295. </table>

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

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

  298. 

  299. </div>

  300. </div>

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

  302. <div class="memitem">

  303. <div class="memproto">

  304. <table class="mlabels">

  305.   <tr>

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

  307.       <table class="memname">

  308.         <tr>

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

  310.           <td>(</td>

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

  312.           <td> const</td>

  313.         </tr>

  314.       </table>

  315.   </td>

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

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

  318.   </tr>

  319. </table>

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

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

  322. 

  323. </div>

  324. </div>

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

  326. <div class="memitem">

  327. <div class="memproto">

  328. <table class="mlabels">

  329.   <tr>

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

  331.       <table class="memname">

  332.         <tr>

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

  334.           <td>(</td>

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

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

  337.         </tr>

  338.         <tr>

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

  340.           <td></td>

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

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

  343.         </tr>

  344.         <tr>

  345.           <td></td>

  346.           <td>)</td>

  347.           <td></td><td></td>

  348.         </tr>

  349.       </table>

  350.   </td>

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

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

  353.   </tr>

  354. </table>

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

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

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

  358.   <table class="params">

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

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

  361.   </table>

  362.   </dd>

  363. </dl>

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

  365. 

  366. </div>

  367. </div>

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

  369. <div class="memitem">

  370. <div class="memproto">

  371. <table class="mlabels">

  372.   <tr>

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

  374.       <table class="memname">

  375.         <tr>

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

  377.           <td>(</td>

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

  379.           <td></td>

  380.         </tr>

  381.       </table>

  382.   </td>

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

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

  385.   </tr>

  386. </table>

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

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

  389. 

  390. </div>

  391. </div>

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

  393. <div class="memitem">

  394. <div class="memproto">

  395. <table class="mlabels">

  396.   <tr>

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

  398.       <table class="memname">

  399.         <tr>

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

  401.           <td>(</td>

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

  403.           <td> const</td>

  404.         </tr>

  405.       </table>

  406.   </td>

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

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

  409.   </tr>

  410. </table>

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

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

  413. 

  414. </div>

  415. </div>

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

  417. <div class="memitem">

  418. <div class="memproto">

  419. <table class="mlabels">

  420.   <tr>

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

  422.       <table class="memname">

  423.         <tr>

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

  425.           <td>(</td>

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

  427.           <td> const</td>

  428.         </tr>

  429.       </table>

  430.   </td>

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

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

  433.   </tr>

  434. </table>

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

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

  437. 

  438. </div>

  439. </div>

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

  441. <div class="memitem">

  442. <div class="memproto">

  443.       <table class="memname">

  444.         <tr>

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

  446.           <td>(</td>

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

  448.           <td></td>

  449.         </tr>

  450.       </table>

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

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

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

  454. 

  455. </div>

  456. </div>

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

  458. <div class="memitem">

  459. <div class="memproto">

  460. <table class="mlabels">

  461.   <tr>

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

  463.       <table class="memname">

  464.         <tr>

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

  466.           <td>(</td>

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

  468.           <td></td>

  469.         </tr>

  470.       </table>

  471.   </td>

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

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

  474.   </tr>

  475. </table>

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

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

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

  479. 

  480. </div>

  481. </div>

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

  483. <div class="memitem">

  484. <div class="memproto">

  485.       <table class="memname">

  486.         <tr>

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

  488.           <td>(</td>

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

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

  491.           <td></td>

  492.         </tr>

  493.       </table>

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

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

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

  497.   <table class="params">

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

  499.   </table>

  500.   </dd>

  501. </dl>

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

  503. 

  504. </div>

  505. </div>

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

  507. <div class="memitem">

  508. <div class="memproto">

  509. <table class="mlabels">

  510.   <tr>

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

  512.       <table class="memname">

  513.         <tr>

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

  515.           <td>(</td>

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

  517.           <td> const</td>

  518.         </tr>

  519.       </table>

  520.   </td>

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

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

  523.   </tr>

  524. </table>

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

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

  527. 

  528. </div>

  529. </div>

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

  531. <div class="memitem">

  532. <div class="memproto">

  533. <table class="mlabels">

  534.   <tr>

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

  536.       <table class="memname">

  537.         <tr>

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

  539.           <td>(</td>

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

  541.           <td> const</td>

  542.         </tr>

  543.       </table>

  544.   </td>

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

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

  547.   </tr>

  548. </table>

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

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

  551. 

  552. </div>

  553. </div>

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

  555. <div class="memitem">

  556. <div class="memproto">

  557. <table class="mlabels">

  558.   <tr>

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

  560.       <table class="memname">

  561.         <tr>

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

  563.           <td>(</td>

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

  565.           <td> const</td>

  566.         </tr>

  567.       </table>

  568.   </td>

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

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

  571.   </tr>

  572. </table>

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

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

  575. 

  576. </div>

  577. </div>

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

  579. <div class="memitem">

  580. <div class="memproto">

  581.       <table class="memname">

  582.         <tr>

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

  584.           <td>(</td>

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

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

  587.           <td></td>

  588.         </tr>

  589.       </table>

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

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

  592.   <table class="params">

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

  594.   </table>

  595.   </dd>

  596. </dl>

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

  598. 

  599. </div>

  600. </div>

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

  602. <li>Arduino/libraries/SdFat/utility/<a class="el" href="_fat_volume_8h.html">FatVolume.h</a></li>

  603. <li>Arduino/libraries/SdFat/utility/FatVolume.cpp</li>

  604. </ul>

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

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

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

  608. Generated on Sun Feb 1 2015 10:21:40 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  610. </a> 1.8.8

  611. </small></address>

  612. </body>

  613. </html>