visus
/
teensy-sdfat
Следить 1
В избранное 0
Форкнуть 0
Код Задачи 0 Pull Request'ы 0 Релизы 0 Вики Активность
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
42 коммитов
1 ветка
Дерево: 7871875f5c
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из '7871875f5c'
${ noResults }
teensy-sdfat/extras/html/class_fat_volume.html

627 lines
28KB
Исходник Blame История 

  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,81,245,108"/>

  103. <area shape="rect" id="node3" href="class_sd_file_system.html" title="Virtual base class for SdFat library. " alt="" coords="293,5,503,32"/>

  104. <area shape="rect" id="node4" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdioCard \&gt;" alt="" coords="307,56,489,83"/>

  105. <area shape="rect" id="node6" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCard \&gt;" alt="" coords="303,107,493,133"/>

  106. <area shape="rect" id="node9" href="class_sd_file_system.html" title="SdFileSystem\&lt; SdSpiCardEX \&gt;" alt="" coords="295,195,501,221"/>

  107. <area shape="rect" id="node5" href="class_sd_fat_sdio.html" title="SdFat class using SDIO. " alt="" coords="599,27,681,53"/>

  108. <area shape="rect" id="node7" href="class_sd_fat.html" title="Main file system class for SdFat library. " alt="" coords="611,77,669,104"/>

  109. <area shape="rect" id="node8" href="class_sd_fat_soft_spi.html" title="SdFat class using software SPI. " alt="" coords="559,129,721,170"/>

  110. <area shape="rect" id="node10" href="class_sd_fat_e_x.html" title="SdFat class with extended SD I/O. " alt="" coords="603,195,677,221"/>

  111. <area shape="rect" id="node11" href="class_sd_fat_soft_spi_e_x.html" title="SdFat class using software SPI and extended SD I/O. " alt="" coords="551,246,729,287"/>

  112. </map>

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

  114. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  165. </table>

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

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

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

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

  170. <div class="memitem">

  171. <div class="memproto">

  172. <table class="mlabels">

  173.   <tr>

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

  175.       <table class="memname">

  176.         <tr>

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

  178.           <td>(</td>

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

  180.           <td></td>

  181.         </tr>

  182.       </table>

  183.   </td>

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

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

  186.   </tr>

  187. </table>

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

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

  190. 

  191. </div>

  192. </div>

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

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

  195. <div class="memitem">

  196. <div class="memproto">

  197. <table class="mlabels">

  198.   <tr>

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

  200.       <table class="memname">

  201.         <tr>

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

  203.           <td>(</td>

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

  205.           <td> const</td>

  206.         </tr>

  207.       </table>

  208.   </td>

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

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

  211.   </tr>

  212. </table>

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

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

  215. 

  216. </div>

  217. </div>

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

  219. <div class="memitem">

  220. <div class="memproto">

  221. <table class="mlabels">

  222.   <tr>

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

  224.       <table class="memname">

  225.         <tr>

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

  227.           <td>(</td>

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

  229.           <td> const</td>

  230.         </tr>

  231.       </table>

  232.   </td>

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

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

  235.   </tr>

  236. </table>

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

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

  239. 

  240. </div>

  241. </div>

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

  243. <div class="memitem">

  244. <div class="memproto">

  245. <table class="mlabels">

  246.   <tr>

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

  248.       <table class="memname">

  249.         <tr>

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

  251.           <td>(</td>

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

  253.           <td></td>

  254.         </tr>

  255.       </table>

  256.   </td>

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

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

  259.   </tr>

  260. </table>

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

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

  263. 

  264. </div>

  265. </div>

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

  267. <div class="memitem">

  268. <div class="memproto">

  269. <table class="mlabels">

  270.   <tr>

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

  272.       <table class="memname">

  273.         <tr>

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

  275.           <td>(</td>

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

  277.           <td> const</td>

  278.         </tr>

  279.       </table>

  280.   </td>

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

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

  283.   </tr>

  284. </table>

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

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

  287. 

  288. </div>

  289. </div>

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

  291. <div class="memitem">

  292. <div class="memproto">

  293. <table class="mlabels">

  294.   <tr>

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

  296.       <table class="memname">

  297.         <tr>

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

  299.           <td>(</td>

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

  301.           <td> const</td>

  302.         </tr>

  303.       </table>

  304.   </td>

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

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

  307.   </tr>

  308. </table>

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

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

  311. 

  312. </div>

  313. </div>

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

  315. <div class="memitem">

  316. <div class="memproto">

  317. <table class="mlabels">

  318.   <tr>

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

  320.       <table class="memname">

  321.         <tr>

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

  323.           <td>(</td>

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

  325.           <td> const</td>

  326.         </tr>

  327.       </table>

  328.   </td>

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

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

  331.   </tr>

  332. </table>

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

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

  335. 

  336. </div>

  337. </div>

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

  339. <div class="memitem">

  340. <div class="memproto">

  341. <table class="mlabels">

  342.   <tr>

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

  344.       <table class="memname">

  345.         <tr>

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

  347.           <td>(</td>

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

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

  350.         </tr>

  351.         <tr>

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

  353.           <td></td>

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

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

  356.         </tr>

  357.         <tr>

  358.           <td></td>

  359.           <td>)</td>

  360.           <td></td><td></td>

  361.         </tr>

  362.       </table>

  363.   </td>

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

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

  366.   </tr>

  367. </table>

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

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

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

  371.   <table class="params">

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

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

  374.   </table>

  375.   </dd>

  376. </dl>

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

  378. 

  379. </div>

  380. </div>

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

  382. <div class="memitem">

  383. <div class="memproto">

  384. <table class="mlabels">

  385.   <tr>

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

  387.       <table class="memname">

  388.         <tr>

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

  390.           <td>(</td>

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

  392.           <td></td>

  393.         </tr>

  394.       </table>

  395.   </td>

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

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

  398.   </tr>

  399. </table>

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

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

  402. 

  403. </div>

  404. </div>

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

  406. <div class="memitem">

  407. <div class="memproto">

  408. <table class="mlabels">

  409.   <tr>

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

  411.       <table class="memname">

  412.         <tr>

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

  414.           <td>(</td>

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

  416.           <td> const</td>

  417.         </tr>

  418.       </table>

  419.   </td>

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

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

  422.   </tr>

  423. </table>

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

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

  426. 

  427. </div>

  428. </div>

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

  430. <div class="memitem">

  431. <div class="memproto">

  432. <table class="mlabels">

  433.   <tr>

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

  435.       <table class="memname">

  436.         <tr>

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

  438.           <td>(</td>

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

  440.           <td> const</td>

  441.         </tr>

  442.       </table>

  443.   </td>

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

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

  446.   </tr>

  447. </table>

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

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

  450. 

  451. </div>

  452. </div>

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

  454. <div class="memitem">

  455. <div class="memproto">

  456.       <table class="memname">

  457.         <tr>

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

  459.           <td>(</td>

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

  461.           <td></td>

  462.         </tr>

  463.       </table>

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

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

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

  467. 

  468. </div>

  469. </div>

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

  471. <div class="memitem">

  472. <div class="memproto">

  473. <table class="mlabels">

  474.   <tr>

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

  476.       <table class="memname">

  477.         <tr>

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

  479.           <td>(</td>

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

  481.           <td></td>

  482.         </tr>

  483.       </table>

  484.   </td>

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

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

  487.   </tr>

  488. </table>

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

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

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

  492. 

  493. </div>

  494. </div>

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

  496. <div class="memitem">

  497. <div class="memproto">

  498.       <table class="memname">

  499.         <tr>

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

  501.           <td>(</td>

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

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

  504.           <td></td>

  505.         </tr>

  506.       </table>

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

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

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

  510.   <table class="params">

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

  512.   </table>

  513.   </dd>

  514. </dl>

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

  516. 

  517. </div>

  518. </div>

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

  520. <div class="memitem">

  521. <div class="memproto">

  522. <table class="mlabels">

  523.   <tr>

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

  525.       <table class="memname">

  526.         <tr>

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

  528.           <td>(</td>

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

  530.           <td> const</td>

  531.         </tr>

  532.       </table>

  533.   </td>

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

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

  536.   </tr>

  537. </table>

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

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

  540. 

  541. </div>

  542. </div>

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

  544. <div class="memitem">

  545. <div class="memproto">

  546. <table class="mlabels">

  547.   <tr>

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

  549.       <table class="memname">

  550.         <tr>

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

  552.           <td>(</td>

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

  554.           <td> const</td>

  555.         </tr>

  556.       </table>

  557.   </td>

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

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

  560.   </tr>

  561. </table>

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

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

  564. 

  565. </div>

  566. </div>

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

  568. <div class="memitem">

  569. <div class="memproto">

  570. <table class="mlabels">

  571.   <tr>

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

  573.       <table class="memname">

  574.         <tr>

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

  576.           <td>(</td>

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

  578.           <td> const</td>

  579.         </tr>

  580.       </table>

  581.   </td>

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

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

  584.   </tr>

  585. </table>

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

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

  588. 

  589. </div>

  590. </div>

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

  592. <div class="memitem">

  593. <div class="memproto">

  594.       <table class="memname">

  595.         <tr>

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

  597.           <td>(</td>

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

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

  600.           <td></td>

  601.         </tr>

  602.       </table>

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

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

  605.   <table class="params">

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

  607.   </table>

  608.   </dd>

  609. </dl>

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

  611. 

  612. </div>

  613. </div>

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

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

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

  617. </ul>

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

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

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

  621. Generated on Mon Sep 5 2016 10:18:52 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  623. </a> 1.8.10

  624. </small></address>

  625. </body>

  626. </html>