visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11 Commits
1 Branch
Tree: 8408432732
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '8408432732'
${ noResults }
teensy-sdfat/html/class_sd_volume.html

627 lines
29KB
Raw Blame History 

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

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

  3. <head>

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

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

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

  7. <title>SdFat: SdVolume 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="class_sd_volume-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

  88. <div class="title">SdVolume Class Reference</div>  </div>

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

  90. <div class="contents">

  91. 

  92. <p><a class="el" href="class_sd_volume.html" title="SdVolume used in Quick start. Soon to be removed. ">SdVolume</a> used in Quick start. Soon to be removed.  

  93.  <a href="class_sd_volume.html#details">More...</a></p>

  94. 

  95. <p><code>#include &lt;SdVolume.h&gt;</code></p>

  96. <div class="dynheader">

  97. Inheritance diagram for SdVolume:</div>

  98. <div class="dyncontent">

  99. <div class="center"><img src="class_sd_volume__inherit__graph.png" border="0" usemap="#_sd_volume_inherit__map" alt="Inheritance graph"/></div>

  100. <map name="_sd_volume_inherit__map" id="_sd_volume_inherit__map">

  101. <area shape="rect" id="node2" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="5,5,91,32"/>
</map>

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

  103. <div class="dynheader">

  104. Collaboration diagram for SdVolume:</div>

  105. <div class="dyncontent">

  106. <div class="center"><img src="class_sd_volume__coll__graph.png" border="0" usemap="#_sd_volume_coll__map" alt="Collaboration graph"/></div>

  107. <map name="_sd_volume_coll__map" id="_sd_volume_coll__map">

  108. <area shape="rect" id="node2" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. " alt="" coords="5,5,91,32"/>
</map>

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

  110. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  135. <tr class="memitem:a0ac221eda119ddccae8ac6bc20a4b12d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a0ac221eda119ddccae8ac6bc20a4b12d">init</a> (<a class="el" href="class_sd2_card.html">Sd2Card</a> *dev)</td></tr>

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

  137. <tr class="memitem:ae820ee8d9ea7ed01ce72ae3508a63cbf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#ae820ee8d9ea7ed01ce72ae3508a63cbf">init</a> (<a class="el" href="class_sd2_card.html">Sd2Card</a> *dev, uint8_t part)</td></tr>

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

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

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

  141. <tr class="memitem:a034d997a1e7a0b2b664a4357bcccd256"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a034d997a1e7a0b2b664a4357bcccd256">init</a> (uint8_t part)</td></tr>

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

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

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

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

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

  147. </table>

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

  149. <div class="textblock"><p><a class="el" href="class_sd_volume.html" title="SdVolume used in Quick start. Soon to be removed. ">SdVolume</a> used in Quick start. Soon to be removed. </p>

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

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

  152. <div class="memitem">

  153. <div class="memproto">

  154. <table class="mlabels">

  155.   <tr>

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

  157.       <table class="memname">

  158.         <tr>

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

  160.           <td>(</td>

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

  162.           <td> const</td>

  163.         </tr>

  164.       </table>

  165.   </td>

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

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

  168.   </tr>

  169. </table>

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

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

  172. 

  173. </div>

  174. </div>

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

  176. <div class="memitem">

  177. <div class="memproto">

  178. <table class="mlabels">

  179.   <tr>

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

  181.       <table class="memname">

  182.         <tr>

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

  184.           <td>(</td>

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

  186.           <td> const</td>

  187.         </tr>

  188.       </table>

  189.   </td>

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

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

  192.   </tr>

  193. </table>

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

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

  196. 

  197. </div>

  198. </div>

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

  200. <div class="memitem">

  201. <div class="memproto">

  202. <table class="mlabels">

  203.   <tr>

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

  205.       <table class="memname">

  206.         <tr>

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

  208.           <td>(</td>

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

  210.           <td></td>

  211.         </tr>

  212.       </table>

  213.   </td>

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

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

  216.   </tr>

  217. </table>

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

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

  220. 

  221. </div>

  222. </div>

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

  224. <div class="memitem">

  225. <div class="memproto">

  226. <table class="mlabels">

  227.   <tr>

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

  229.       <table class="memname">

  230.         <tr>

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

  232.           <td>(</td>

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

  234.           <td> const</td>

  235.         </tr>

  236.       </table>

  237.   </td>

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

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

  240.   </tr>

  241. </table>

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

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

  244. 

  245. </div>

  246. </div>

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

  248. <div class="memitem">

  249. <div class="memproto">

  250. <table class="mlabels">

  251.   <tr>

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

  253.       <table class="memname">

  254.         <tr>

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

  256.           <td>(</td>

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

  258.           <td> const</td>

  259.         </tr>

  260.       </table>

  261.   </td>

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

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

  264.   </tr>

  265. </table>

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

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

  268. 

  269. </div>

  270. </div>

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

  272. <div class="memitem">

  273. <div class="memproto">

  274. <table class="mlabels">

  275.   <tr>

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

  277.       <table class="memname">

  278.         <tr>

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

  280.           <td>(</td>

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

  282.           <td> const</td>

  283.         </tr>

  284.       </table>

  285.   </td>

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

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

  288.   </tr>

  289. </table>

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

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

  292. 

  293. </div>

  294. </div>

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

  296. <div class="memitem">

  297. <div class="memproto">

  298. <table class="mlabels">

  299.   <tr>

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

  301.       <table class="memname">

  302.         <tr>

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

  304.           <td>(</td>

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

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

  307.         </tr>

  308.         <tr>

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

  310.           <td></td>

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

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

  313.         </tr>

  314.         <tr>

  315.           <td></td>

  316.           <td>)</td>

  317.           <td></td><td></td>

  318.         </tr>

  319.       </table>

  320.   </td>

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

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

  323.   </tr>

  324. </table>

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

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

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

  328.   <table class="params">

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

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

  331.   </table>

  332.   </dd>

  333. </dl>

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

  335. 

  336. </div>

  337. </div>

  338. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></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">uint8_t FatVolume::fatCount </td>

  347.           <td>(</td>

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

  349.           <td></td>

  350.         </tr>

  351.       </table>

  352.   </td>

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

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

  355.   </tr>

  356. </table>

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

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

  359. 

  360. </div>

  361. </div>

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

  363. <div class="memitem">

  364. <div class="memproto">

  365. <table class="mlabels">

  366.   <tr>

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

  368.       <table class="memname">

  369.         <tr>

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

  371.           <td>(</td>

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

  373.           <td> const</td>

  374.         </tr>

  375.       </table>

  376.   </td>

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

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

  379.   </tr>

  380. </table>

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

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

  383. 

  384. </div>

  385. </div>

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

  387. <div class="memitem">

  388. <div class="memproto">

  389. <table class="mlabels">

  390.   <tr>

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

  392.       <table class="memname">

  393.         <tr>

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

  395.           <td>(</td>

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

  397.           <td> const</td>

  398.         </tr>

  399.       </table>

  400.   </td>

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

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

  403.   </tr>

  404. </table>

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

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

  407. 

  408. </div>

  409. </div>

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

  411. <div class="memitem">

  412. <div class="memproto">

  413. <table class="mlabels">

  414.   <tr>

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

  416.       <table class="memname">

  417.         <tr>

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

  419.           <td>(</td>

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

  421.           <td></td>

  422.         </tr>

  423.       </table>

  424.   </td>

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

  426. <span class="mlabels"><span class="mlabel">inherited</span></span>  </td>

  427.   </tr>

  428. </table>

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

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

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

  432. 

  433. </div>

  434. </div>

  435. <a class="anchor" id="a0ac221eda119ddccae8ac6bc20a4b12d"></a>

  436. <div class="memitem">

  437. <div class="memproto">

  438. <table class="mlabels">

  439.   <tr>

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

  441.       <table class="memname">

  442.         <tr>

  443.           <td class="memname">bool SdVolume::init </td>

  444.           <td>(</td>

  445.           <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>

  446.           <td class="paramname"><em>dev</em></td><td>)</td>

  447.           <td></td>

  448.         </tr>

  449.       </table>

  450.   </td>

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

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

  453.   </tr>

  454. </table>

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

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

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

  458.   <table class="params">

  459.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The <a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC card using default SPI library. ">Sd2Card</a> where the volume is located.</td></tr>

  460.   </table>

  461.   </dd>

  462. </dl>

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

  464. 

  465. </div>

  466. </div>

  467. <a class="anchor" id="ae820ee8d9ea7ed01ce72ae3508a63cbf"></a>

  468. <div class="memitem">

  469. <div class="memproto">

  470. <table class="mlabels">

  471.   <tr>

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

  473.       <table class="memname">

  474.         <tr>

  475.           <td class="memname">bool SdVolume::init </td>

  476.           <td>(</td>

  477.           <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>

  478.           <td class="paramname"><em>dev</em>, </td>

  479.         </tr>

  480.         <tr>

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

  482.           <td></td>

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

  484.           <td class="paramname"><em>part</em>&#160;</td>

  485.         </tr>

  486.         <tr>

  487.           <td></td>

  488.           <td>)</td>

  489.           <td></td><td></td>

  490.         </tr>

  491.       </table>

  492.   </td>

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

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

  495.   </tr>

  496. </table>

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

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

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

  500.   <table class="params">

  501.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The <a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC card using default SPI library. ">Sd2Card</a> where the volume is located. </td></tr>

  502.     <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>the partition to use. Zero for super floppy or 1-4. </td></tr>

  503.   </table>

  504.   </dd>

  505. </dl>

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

  507. 

  508. </div>

  509. </div>

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

  511. <div class="memitem">

  512. <div class="memproto">

  513. <table class="mlabels">

  514.   <tr>

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

  516.       <table class="memname">

  517.         <tr>

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

  519.           <td>(</td>

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

  521.           <td></td>

  522.         </tr>

  523.       </table>

  524.   </td>

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

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

  527.   </tr>

  528. </table>

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

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

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

  532. 

  533. </div>

  534. </div>

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

  536. <div class="memitem">

  537. <div class="memproto">

  538. <table class="mlabels">

  539.   <tr>

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

  541.       <table class="memname">

  542.         <tr>

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

  544.           <td>(</td>

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

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

  547.           <td></td>

  548.         </tr>

  549.       </table>

  550.   </td>

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

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

  553.   </tr>

  554. </table>

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

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

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

  558.   <table class="params">

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

  560.   </table>

  561.   </dd>

  562. </dl>

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

  564. 

  565. </div>

  566. </div>

  567. <a class="anchor" id="ae86d9615ddfb386c1ba8af5de23519d9"></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::rootDirEntryCount </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 class="mlabel">inherited</span></span>  </td>

  584.   </tr>

  585. </table>

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

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

  588. 

  589. </div>

  590. </div>

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

  592. <div class="memitem">

  593. <div class="memproto">

  594. <table class="mlabels">

  595.   <tr>

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

  597.       <table class="memname">

  598.         <tr>

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

  600.           <td>(</td>

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

  602.           <td> const</td>

  603.         </tr>

  604.       </table>

  605.   </td>

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

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

  608.   </tr>

  609. </table>

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

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

  612. 

  613. </div>

  614. </div>

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

  616. <li>Arduino/libraries/SdFat/SdVolume.h</li>

  617. </ul>

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

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

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

  621. Generated on Sat Nov 15 2014 10:05:36 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.8

  624. </small></address>

  625. </body>

  626. </html>