Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

627 linhas
29KB

  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. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#pub-methods">Public Member Functions</a> &#124;
  84. <a href="class_sd_volume-members.html">List of all members</a> </div>
  85. <div class="headertitle">
  86. <div class="title">SdVolume Class Reference</div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <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.
  90. <a href="class_sd_volume.html#details">More...</a></p>
  91. <p><code>#include &lt;SdVolume.h&gt;</code></p>
  92. <div class="dynheader">
  93. Inheritance diagram for SdVolume:</div>
  94. <div class="dyncontent">
  95. <div class="center"><img src="class_sd_volume__inherit__graph.png" border="0" usemap="#_sd_volume_inherit__map" alt="Inheritance graph"/></div>
  96. <map name="_sd_volume_inherit__map" id="_sd_volume_inherit__map">
  97. <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>
  98. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  99. <div class="dynheader">
  100. Collaboration diagram for SdVolume:</div>
  101. <div class="dyncontent">
  102. <div class="center"><img src="class_sd_volume__coll__graph.png" border="0" usemap="#_sd_volume_coll__map" alt="Collaboration graph"/></div>
  103. <map name="_sd_volume_coll__map" id="_sd_volume_coll__map">
  104. <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>
  105. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  106. <table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  108. Public Member Functions</h2></td></tr>
  109. <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>
  110. <tr class="separator:a06beed4cea5e38116b58254a57125442"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:abc66d856d05198d9ebe7104c8c4155d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:aa1e3b1d0c21d202deb82668068ab00e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:a18446a9c5924304fa7a87d5f03ccaf21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:ac0e63f33d71d5dc95a602834274def6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:a443364af257c219f8e908d5b073d8fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:a2439fdebcf60a9226d2563600bbb752d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:acdedc6a200b01e401c9cd9b511eae6ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:a0dd0cc689b63ef0702aed1cf36b1722d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:a1364f11fe9bb4717ce0685e2b7b86027"><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: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>
  132. <tr class="separator:a0ac221eda119ddccae8ac6bc20a4b12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:ae820ee8d9ea7ed01ce72ae3508a63cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:acab819fa25a91dad1cc698a7e1e0eb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:a034d997a1e7a0b2b664a4357bcccd256"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:ae86d9615ddfb386c1ba8af5de23519d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:ae9363ebbbae90e895ea56e8fa3f60c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table>
  144. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  145. <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>
  146. </div><h2 class="groupheader">Member Function Documentation</h2>
  147. <a class="anchor" id="a06beed4cea5e38116b58254a57125442"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="mlabels">
  151. <tr>
  152. <td class="mlabels-left">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">uint8_t FatVolume::blocksPerCluster </td>
  156. <td>(</td>
  157. <td class="paramname"></td><td>)</td>
  158. <td> const</td>
  159. </tr>
  160. </table>
  161. </td>
  162. <td class="mlabels-right">
  163. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>
  168. </div>
  169. </div>
  170. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">uint32_t FatVolume::blocksPerFat </td>
  179. <td>(</td>
  180. <td class="paramname"></td><td>)</td>
  181. <td> const</td>
  182. </tr>
  183. </table>
  184. </td>
  185. <td class="mlabels-right">
  186. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  191. </div>
  192. </div>
  193. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="mlabels">
  197. <tr>
  198. <td class="mlabels-left">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>
  202. <td>(</td>
  203. <td class="paramname"></td><td>)</td>
  204. <td></td>
  205. </tr>
  206. </table>
  207. </td>
  208. <td class="mlabels-right">
  209. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <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>
  214. </div>
  215. </div>
  216. <a class="anchor" id="a18446a9c5924304fa7a87d5f03ccaf21"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">uint32_t FatVolume::clusterCount </td>
  225. <td>(</td>
  226. <td class="paramname"></td><td>)</td>
  227. <td> const</td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  237. </div>
  238. </div>
  239. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="mlabels">
  243. <tr>
  244. <td class="mlabels-left">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">uint8_t FatVolume::clusterSizeShift </td>
  248. <td>(</td>
  249. <td class="paramname"></td><td>)</td>
  250. <td> const</td>
  251. </tr>
  252. </table>
  253. </td>
  254. <td class="mlabels-right">
  255. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>
  260. </div>
  261. </div>
  262. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></a>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="mlabels">
  266. <tr>
  267. <td class="mlabels-left">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">uint32_t FatVolume::dataStartBlock </td>
  271. <td>(</td>
  272. <td class="paramname"></td><td>)</td>
  273. <td> const</td>
  274. </tr>
  275. </table>
  276. </td>
  277. <td class="mlabels-right">
  278. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  283. </div>
  284. </div>
  285. <a class="anchor" id="a2439fdebcf60a9226d2563600bbb752d"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">bool FatVolume::dbgFat </td>
  294. <td>(</td>
  295. <td class="paramtype">uint32_t&#160;</td>
  296. <td class="paramname"><em>n</em>, </td>
  297. </tr>
  298. <tr>
  299. <td class="paramkey"></td>
  300. <td></td>
  301. <td class="paramtype">uint32_t *&#160;</td>
  302. <td class="paramname"><em>v</em>&#160;</td>
  303. </tr>
  304. <tr>
  305. <td></td>
  306. <td>)</td>
  307. <td></td><td></td>
  308. </tr>
  309. </table>
  310. </td>
  311. <td class="mlabels-right">
  312. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>Debug access to FAT table</p>
  317. <dl class="params"><dt>Parameters</dt><dd>
  318. <table class="params">
  319. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  320. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  321. </table>
  322. </dd>
  323. </dl>
  324. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>
  325. </div>
  326. </div>
  327. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></a>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="mlabels">
  331. <tr>
  332. <td class="mlabels-left">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">uint8_t FatVolume::fatCount </td>
  336. <td>(</td>
  337. <td class="paramname"></td><td>)</td>
  338. <td></td>
  339. </tr>
  340. </table>
  341. </td>
  342. <td class="mlabels-right">
  343. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <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>
  348. </div>
  349. </div>
  350. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></a>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="mlabels">
  354. <tr>
  355. <td class="mlabels-left">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname">uint32_t FatVolume::fatStartBlock </td>
  359. <td>(</td>
  360. <td class="paramname"></td><td>)</td>
  361. <td> const</td>
  362. </tr>
  363. </table>
  364. </td>
  365. <td class="mlabels-right">
  366. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  371. </div>
  372. </div>
  373. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="mlabels">
  377. <tr>
  378. <td class="mlabels-left">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">uint8_t FatVolume::fatType </td>
  382. <td>(</td>
  383. <td class="paramname"></td><td>)</td>
  384. <td> const</td>
  385. </tr>
  386. </table>
  387. </td>
  388. <td class="mlabels-right">
  389. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  390. </tr>
  391. </table>
  392. </div><div class="memdoc">
  393. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  394. </div>
  395. </div>
  396. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></a>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="mlabels">
  400. <tr>
  401. <td class="mlabels-left">
  402. <table class="memname">
  403. <tr>
  404. <td class="memname">int32_t FatVolume::freeClusterCount </td>
  405. <td>(</td>
  406. <td class="paramname"></td><td>)</td>
  407. <td></td>
  408. </tr>
  409. </table>
  410. </td>
  411. <td class="mlabels-right">
  412. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. <p>Volume free space in clusters.</p>
  417. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  418. </div>
  419. </div>
  420. <a class="anchor" id="a0ac221eda119ddccae8ac6bc20a4b12d"></a>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="mlabels">
  424. <tr>
  425. <td class="mlabels-left">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname">bool SdVolume::init </td>
  429. <td>(</td>
  430. <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>
  431. <td class="paramname"><em>dev</em></td><td>)</td>
  432. <td></td>
  433. </tr>
  434. </table>
  435. </td>
  436. <td class="mlabels-right">
  437. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  442. <dl class="params"><dt>Parameters</dt><dd>
  443. <table class="params">
  444. <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>
  445. </table>
  446. </dd>
  447. </dl>
  448. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  449. </div>
  450. </div>
  451. <a class="anchor" id="ae820ee8d9ea7ed01ce72ae3508a63cbf"></a>
  452. <div class="memitem">
  453. <div class="memproto">
  454. <table class="mlabels">
  455. <tr>
  456. <td class="mlabels-left">
  457. <table class="memname">
  458. <tr>
  459. <td class="memname">bool SdVolume::init </td>
  460. <td>(</td>
  461. <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>
  462. <td class="paramname"><em>dev</em>, </td>
  463. </tr>
  464. <tr>
  465. <td class="paramkey"></td>
  466. <td></td>
  467. <td class="paramtype">uint8_t&#160;</td>
  468. <td class="paramname"><em>part</em>&#160;</td>
  469. </tr>
  470. <tr>
  471. <td></td>
  472. <td>)</td>
  473. <td></td><td></td>
  474. </tr>
  475. </table>
  476. </td>
  477. <td class="mlabels-right">
  478. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  479. </tr>
  480. </table>
  481. </div><div class="memdoc">
  482. <p>Initialize a FAT volume.</p>
  483. <dl class="params"><dt>Parameters</dt><dd>
  484. <table class="params">
  485. <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>
  486. <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>
  487. </table>
  488. </dd>
  489. </dl>
  490. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  491. </div>
  492. </div>
  493. <a class="anchor" id="acab819fa25a91dad1cc698a7e1e0eb32"></a>
  494. <div class="memitem">
  495. <div class="memproto">
  496. <table class="mlabels">
  497. <tr>
  498. <td class="mlabels-left">
  499. <table class="memname">
  500. <tr>
  501. <td class="memname">bool FatVolume::init </td>
  502. <td>(</td>
  503. <td class="paramname"></td><td>)</td>
  504. <td></td>
  505. </tr>
  506. </table>
  507. </td>
  508. <td class="mlabels-right">
  509. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  510. </tr>
  511. </table>
  512. </div><div class="memdoc">
  513. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  514. <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>
  515. </div>
  516. </div>
  517. <a class="anchor" id="a034d997a1e7a0b2b664a4357bcccd256"></a>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="mlabels">
  521. <tr>
  522. <td class="mlabels-left">
  523. <table class="memname">
  524. <tr>
  525. <td class="memname">bool FatVolume::init </td>
  526. <td>(</td>
  527. <td class="paramtype">uint8_t&#160;</td>
  528. <td class="paramname"><em>part</em></td><td>)</td>
  529. <td></td>
  530. </tr>
  531. </table>
  532. </td>
  533. <td class="mlabels-right">
  534. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  535. </tr>
  536. </table>
  537. </div><div class="memdoc">
  538. <p>Initialize a FAT volume.</p>
  539. <dl class="params"><dt>Parameters</dt><dd>
  540. <table class="params">
  541. <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>
  542. </table>
  543. </dd>
  544. </dl>
  545. <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>
  546. </div>
  547. </div>
  548. <a class="anchor" id="ae86d9615ddfb386c1ba8af5de23519d9"></a>
  549. <div class="memitem">
  550. <div class="memproto">
  551. <table class="mlabels">
  552. <tr>
  553. <td class="mlabels-left">
  554. <table class="memname">
  555. <tr>
  556. <td class="memname">uint32_t FatVolume::rootDirEntryCount </td>
  557. <td>(</td>
  558. <td class="paramname"></td><td>)</td>
  559. <td> const</td>
  560. </tr>
  561. </table>
  562. </td>
  563. <td class="mlabels-right">
  564. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  565. </tr>
  566. </table>
  567. </div><div class="memdoc">
  568. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  569. </div>
  570. </div>
  571. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>
  572. <div class="memitem">
  573. <div class="memproto">
  574. <table class="mlabels">
  575. <tr>
  576. <td class="mlabels-left">
  577. <table class="memname">
  578. <tr>
  579. <td class="memname">uint32_t FatVolume::rootDirStart </td>
  580. <td>(</td>
  581. <td class="paramname"></td><td>)</td>
  582. <td> const</td>
  583. </tr>
  584. </table>
  585. </td>
  586. <td class="mlabels-right">
  587. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  588. </tr>
  589. </table>
  590. </div><div class="memdoc">
  591. <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>
  592. </div>
  593. </div>
  594. <hr/>The documentation for this class was generated from the following file:<ul>
  595. <li>Arduino/libraries/SdFat/SdVolume.h</li>
  596. </ul>
  597. </div><!-- contents -->
  598. <!-- start footer part -->
  599. <hr class="footer"/><address class="footer"><small>
  600. Generated on Sat Nov 15 2014 10:05:36 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  601. <img class="footer" src="doxygen.png" alt="doxygen"/>
  602. </a> 1.8.8
  603. </small></address>
  604. </body>
  605. </html>