visus
/
teensy-sdfat
보기 1
좋아요 0
포크 0
코드 이슈 0 풀 리퀘스트 0 릴리즈 0 위키 Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11 커밋
1 브렌치
트리: 8408432732
브랜치 태그
${ item.name }
Create branch ${ searchTerm }
from '8408432732'
${ noResults }
teensy-sdfat/html/class_fat_volume.html

563 lines
26KB
Raw 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.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 used in Quick start. 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:a2439fdebcf60a9226d2563600bbb752d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a2439fdebcf60a9226d2563600bbb752d">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>

  120. <tr class="separator:a2439fdebcf60a9226d2563600bbb752d"><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:ae86d9615ddfb386c1ba8af5de23519d9"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ae86d9615ddfb386c1ba8af5de23519d9">rootDirEntryCount</a> () const </td></tr>

  136. <tr class="separator:ae86d9615ddfb386c1ba8af5de23519d9"><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. </table><table class="memberdecls">

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

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

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

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

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

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

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

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

  148. </table>

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

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

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

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

  153. <div class="memitem">

  154. <div class="memproto">

  155. <table class="mlabels">

  156.   <tr>

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

  158.       <table class="memname">

  159.         <tr>

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

  161.           <td>(</td>

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

  163.           <td></td>

  164.         </tr>

  165.       </table>

  166.   </td>

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

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

  169.   </tr>

  170. </table>

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

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

  173. 

  174. </div>

  175. </div>

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

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

  178. <div class="memitem">

  179. <div class="memproto">

  180. <table class="mlabels">

  181.   <tr>

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

  183.       <table class="memname">

  184.         <tr>

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

  186.           <td>(</td>

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

  188.           <td> const</td>

  189.         </tr>

  190.       </table>

  191.   </td>

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

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

  194.   </tr>

  195. </table>

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

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

  198. 

  199. </div>

  200. </div>

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

  202. <div class="memitem">

  203. <div class="memproto">

  204. <table class="mlabels">

  205.   <tr>

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

  207.       <table class="memname">

  208.         <tr>

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

  210.           <td>(</td>

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

  212.           <td> const</td>

  213.         </tr>

  214.       </table>

  215.   </td>

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

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

  218.   </tr>

  219. </table>

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

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

  222. 

  223. </div>

  224. </div>

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

  226. <div class="memitem">

  227. <div class="memproto">

  228. <table class="mlabels">

  229.   <tr>

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

  231.       <table class="memname">

  232.         <tr>

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

  234.           <td>(</td>

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

  236.           <td></td>

  237.         </tr>

  238.       </table>

  239.   </td>

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

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

  242.   </tr>

  243. </table>

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

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

  246. 

  247. </div>

  248. </div>

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

  250. <div class="memitem">

  251. <div class="memproto">

  252. <table class="mlabels">

  253.   <tr>

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

  255.       <table class="memname">

  256.         <tr>

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

  258.           <td>(</td>

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

  260.           <td> const</td>

  261.         </tr>

  262.       </table>

  263.   </td>

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

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

  266.   </tr>

  267. </table>

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

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

  270. 

  271. </div>

  272. </div>

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

  274. <div class="memitem">

  275. <div class="memproto">

  276. <table class="mlabels">

  277.   <tr>

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

  279.       <table class="memname">

  280.         <tr>

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

  282.           <td>(</td>

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

  284.           <td> const</td>

  285.         </tr>

  286.       </table>

  287.   </td>

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

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

  290.   </tr>

  291. </table>

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

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

  294. 

  295. </div>

  296. </div>

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

  298. <div class="memitem">

  299. <div class="memproto">

  300. <table class="mlabels">

  301.   <tr>

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

  303.       <table class="memname">

  304.         <tr>

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

  306.           <td>(</td>

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

  308.           <td> const</td>

  309.         </tr>

  310.       </table>

  311.   </td>

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

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

  314.   </tr>

  315. </table>

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

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

  318. 

  319. </div>

  320. </div>

  321. <a class="anchor" id="a2439fdebcf60a9226d2563600bbb752d"></a>

  322. <div class="memitem">

  323. <div class="memproto">

  324. <table class="mlabels">

  325.   <tr>

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

  327.       <table class="memname">

  328.         <tr>

  329.           <td class="memname">bool FatVolume::dbgFat </td>

  330.           <td>(</td>

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

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

  333.         </tr>

  334.         <tr>

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

  336.           <td></td>

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

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

  339.         </tr>

  340.         <tr>

  341.           <td></td>

  342.           <td>)</td>

  343.           <td></td><td></td>

  344.         </tr>

  345.       </table>

  346.   </td>

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

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

  349.   </tr>

  350. </table>

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

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

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

  354.   <table class="params">

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

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

  357.   </table>

  358.   </dd>

  359. </dl>

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

  361. 

  362. </div>

  363. </div>

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

  365. <div class="memitem">

  366. <div class="memproto">

  367. <table class="mlabels">

  368.   <tr>

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

  370.       <table class="memname">

  371.         <tr>

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

  373.           <td>(</td>

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

  375.           <td></td>

  376.         </tr>

  377.       </table>

  378.   </td>

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

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

  381.   </tr>

  382. </table>

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

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

  385. 

  386. </div>

  387. </div>

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

  389. <div class="memitem">

  390. <div class="memproto">

  391. <table class="mlabels">

  392.   <tr>

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

  394.       <table class="memname">

  395.         <tr>

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

  397.           <td>(</td>

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

  399.           <td> const</td>

  400.         </tr>

  401.       </table>

  402.   </td>

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

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

  405.   </tr>

  406. </table>

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

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

  409. 

  410. </div>

  411. </div>

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

  413. <div class="memitem">

  414. <div class="memproto">

  415. <table class="mlabels">

  416.   <tr>

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

  418.       <table class="memname">

  419.         <tr>

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

  421.           <td>(</td>

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

  423.           <td> const</td>

  424.         </tr>

  425.       </table>

  426.   </td>

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

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

  429.   </tr>

  430. </table>

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

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

  433. 

  434. </div>

  435. </div>

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

  437. <div class="memitem">

  438. <div class="memproto">

  439.       <table class="memname">

  440.         <tr>

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

  442.           <td>(</td>

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

  444.           <td></td>

  445.         </tr>

  446.       </table>

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

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

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

  450. 

  451. </div>

  452. </div>

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

  454. <div class="memitem">

  455. <div class="memproto">

  456. <table class="mlabels">

  457.   <tr>

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

  459.       <table class="memname">

  460.         <tr>

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

  462.           <td>(</td>

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

  464.           <td></td>

  465.         </tr>

  466.       </table>

  467.   </td>

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

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

  470.   </tr>

  471. </table>

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

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

  474. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include not finding a valid partition, not finding a valid FAT file system or an I/O error. </dd></dl>

  475. 

  476. </div>

  477. </div>

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

  479. <div class="memitem">

  480. <div class="memproto">

  481.       <table class="memname">

  482.         <tr>

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

  484.           <td>(</td>

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

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

  487.           <td></td>

  488.         </tr>

  489.       </table>

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

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

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

  493.   <table class="params">

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

  495.   </table>

  496.   </dd>

  497. </dl>

  498. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include not finding a valid partition, not finding a valid FAT file system in the specified partition or an I/O error. </dd></dl>

  499. 

  500. </div>

  501. </div>

  502. <a class="anchor" id="ae86d9615ddfb386c1ba8af5de23519d9"></a>

  503. <div class="memitem">

  504. <div class="memproto">

  505. <table class="mlabels">

  506.   <tr>

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

  508.       <table class="memname">

  509.         <tr>

  510.           <td class="memname">uint32_t FatVolume::rootDirEntryCount </td>

  511.           <td>(</td>

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

  513.           <td> const</td>

  514.         </tr>

  515.       </table>

  516.   </td>

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

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

  519.   </tr>

  520. </table>

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

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

  523. 

  524. </div>

  525. </div>

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

  527. <div class="memitem">

  528. <div class="memproto">

  529. <table class="mlabels">

  530.   <tr>

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

  532.       <table class="memname">

  533.         <tr>

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

  535.           <td>(</td>

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

  537.           <td> const</td>

  538.         </tr>

  539.       </table>

  540.   </td>

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

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

  543.   </tr>

  544. </table>

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

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

  547. 

  548. </div>

  549. </div>

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

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

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

  553. </ul>

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

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

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

  557. Generated on Sat Nov 15 2014 10:05:36 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  559. </a> 1.8.8

  560. </small></address>

  561. </body>

  562. </html>