No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.

686 líneas
31KB

  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 Soon to be removed. ">SdVolume</a> 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:a25c6311b70fa274b3be94ff25fdebba7"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a25c6311b70fa274b3be94ff25fdebba7">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  122. <tr class="separator:a25c6311b70fa274b3be94ff25fdebba7"><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:ab2d483670a0a6a6a4754b23614fe11bc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#ab2d483670a0a6a6a4754b23614fe11bc">rootDirEntryCount</a> () const </td></tr>
  140. <tr class="separator:ab2d483670a0a6a6a4754b23614fe11bc"><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. <tr class="memitem:a07bc98088ce4a9c725700899c184f7fc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a07bc98088ce4a9c725700899c184f7fc">volumeBlockCount</a> () const </td></tr>
  144. <tr class="separator:a07bc98088ce4a9c725700899c184f7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a8088aa74cf601996905dadd2eea6966c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_volume.html#a8088aa74cf601996905dadd2eea6966c">wipe</a> (<a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *pr=0)</td></tr>
  146. <tr class="separator:a8088aa74cf601996905dadd2eea6966c"><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 Soon to be removed. ">SdVolume</a> 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. </div>
  173. </div>
  174. <a class="anchor" id="abc66d856d05198d9ebe7104c8c4155d7"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="mlabels">
  178. <tr>
  179. <td class="mlabels-left">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">uint32_t FatVolume::blocksPerFat </td>
  183. <td>(</td>
  184. <td class="paramname"></td><td>)</td>
  185. <td> const</td>
  186. </tr>
  187. </table>
  188. </td>
  189. <td class="mlabels-right">
  190. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  195. </div>
  196. </div>
  197. <a class="anchor" id="aa1e3b1d0c21d202deb82668068ab00e8"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="mlabels">
  201. <tr>
  202. <td class="mlabels-left">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatVolume::cacheClear </td>
  206. <td>(</td>
  207. <td class="paramname"></td><td>)</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </td>
  212. <td class="mlabels-right">
  213. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <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>
  218. </div>
  219. </div>
  220. <a class="anchor" id="a18446a9c5924304fa7a87d5f03ccaf21"></a>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">uint32_t FatVolume::clusterCount </td>
  229. <td>(</td>
  230. <td class="paramname"></td><td>)</td>
  231. <td> const</td>
  232. </tr>
  233. </table>
  234. </td>
  235. <td class="mlabels-right">
  236. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  241. </div>
  242. </div>
  243. <a class="anchor" id="ac0e63f33d71d5dc95a602834274def6a"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">uint8_t FatVolume::clusterSizeShift </td>
  252. <td>(</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td> const</td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>
  264. </div>
  265. </div>
  266. <a class="anchor" id="a443364af257c219f8e908d5b073d8fa3"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="mlabels">
  270. <tr>
  271. <td class="mlabels-left">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">uint32_t FatVolume::dataStartBlock </td>
  275. <td>(</td>
  276. <td class="paramname"></td><td>)</td>
  277. <td> const</td>
  278. </tr>
  279. </table>
  280. </td>
  281. <td class="mlabels-right">
  282. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  287. </div>
  288. </div>
  289. <a class="anchor" id="a25c6311b70fa274b3be94ff25fdebba7"></a>
  290. <div class="memitem">
  291. <div class="memproto">
  292. <table class="mlabels">
  293. <tr>
  294. <td class="mlabels-left">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">int8_t FatVolume::dbgFat </td>
  298. <td>(</td>
  299. <td class="paramtype">uint32_t&#160;</td>
  300. <td class="paramname"><em>n</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype">uint32_t *&#160;</td>
  306. <td class="paramname"><em>v</em>&#160;</td>
  307. </tr>
  308. <tr>
  309. <td></td>
  310. <td>)</td>
  311. <td></td><td></td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Debug access to FAT table</p>
  321. <dl class="params"><dt>Parameters</dt><dd>
  322. <table class="params">
  323. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  324. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  325. </table>
  326. </dd>
  327. </dl>
  328. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>
  329. </div>
  330. </div>
  331. <a class="anchor" id="acdedc6a200b01e401c9cd9b511eae6ec"></a>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="mlabels">
  335. <tr>
  336. <td class="mlabels-left">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">uint8_t FatVolume::fatCount </td>
  340. <td>(</td>
  341. <td class="paramname"></td><td>)</td>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </td>
  346. <td class="mlabels-right">
  347. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <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>
  352. </div>
  353. </div>
  354. <a class="anchor" id="a0dd0cc689b63ef0702aed1cf36b1722d"></a>
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="mlabels">
  358. <tr>
  359. <td class="mlabels-left">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname">uint32_t FatVolume::fatStartBlock </td>
  363. <td>(</td>
  364. <td class="paramname"></td><td>)</td>
  365. <td> const</td>
  366. </tr>
  367. </table>
  368. </td>
  369. <td class="mlabels-right">
  370. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  375. </div>
  376. </div>
  377. <a class="anchor" id="a1364f11fe9bb4717ce0685e2b7b86027"></a>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="mlabels">
  381. <tr>
  382. <td class="mlabels-left">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">uint8_t FatVolume::fatType </td>
  386. <td>(</td>
  387. <td class="paramname"></td><td>)</td>
  388. <td> const</td>
  389. </tr>
  390. </table>
  391. </td>
  392. <td class="mlabels-right">
  393. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  398. </div>
  399. </div>
  400. <a class="anchor" id="a1683b063fc6202ab85470b9610f16f93"></a>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="mlabels">
  404. <tr>
  405. <td class="mlabels-left">
  406. <table class="memname">
  407. <tr>
  408. <td class="memname">int32_t FatVolume::freeClusterCount </td>
  409. <td>(</td>
  410. <td class="paramname"></td><td>)</td>
  411. <td></td>
  412. </tr>
  413. </table>
  414. </td>
  415. <td class="mlabels-right">
  416. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  417. </tr>
  418. </table>
  419. </div><div class="memdoc">
  420. <p>Volume free space in clusters.</p>
  421. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  422. </div>
  423. </div>
  424. <a class="anchor" id="a0ac221eda119ddccae8ac6bc20a4b12d"></a>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="mlabels">
  428. <tr>
  429. <td class="mlabels-left">
  430. <table class="memname">
  431. <tr>
  432. <td class="memname">bool SdVolume::init </td>
  433. <td>(</td>
  434. <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>
  435. <td class="paramname"><em>dev</em></td><td>)</td>
  436. <td></td>
  437. </tr>
  438. </table>
  439. </td>
  440. <td class="mlabels-right">
  441. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  442. </tr>
  443. </table>
  444. </div><div class="memdoc">
  445. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  446. <dl class="params"><dt>Parameters</dt><dd>
  447. <table class="params">
  448. <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>
  449. </table>
  450. </dd>
  451. </dl>
  452. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  453. </div>
  454. </div>
  455. <a class="anchor" id="ae820ee8d9ea7ed01ce72ae3508a63cbf"></a>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <table class="mlabels">
  459. <tr>
  460. <td class="mlabels-left">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname">bool SdVolume::init </td>
  464. <td>(</td>
  465. <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>
  466. <td class="paramname"><em>dev</em>, </td>
  467. </tr>
  468. <tr>
  469. <td class="paramkey"></td>
  470. <td></td>
  471. <td class="paramtype">uint8_t&#160;</td>
  472. <td class="paramname"><em>part</em>&#160;</td>
  473. </tr>
  474. <tr>
  475. <td></td>
  476. <td>)</td>
  477. <td></td><td></td>
  478. </tr>
  479. </table>
  480. </td>
  481. <td class="mlabels-right">
  482. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <p>Initialize a FAT volume.</p>
  487. <dl class="params"><dt>Parameters</dt><dd>
  488. <table class="params">
  489. <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>
  490. <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>
  491. </table>
  492. </dd>
  493. </dl>
  494. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  495. </div>
  496. </div>
  497. <a class="anchor" id="acab819fa25a91dad1cc698a7e1e0eb32"></a>
  498. <div class="memitem">
  499. <div class="memproto">
  500. <table class="mlabels">
  501. <tr>
  502. <td class="mlabels-left">
  503. <table class="memname">
  504. <tr>
  505. <td class="memname">bool FatVolume::init </td>
  506. <td>(</td>
  507. <td class="paramname"></td><td>)</td>
  508. <td></td>
  509. </tr>
  510. </table>
  511. </td>
  512. <td class="mlabels-right">
  513. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  514. </tr>
  515. </table>
  516. </div><div class="memdoc">
  517. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  518. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  519. </div>
  520. </div>
  521. <a class="anchor" id="a034d997a1e7a0b2b664a4357bcccd256"></a>
  522. <div class="memitem">
  523. <div class="memproto">
  524. <table class="mlabels">
  525. <tr>
  526. <td class="mlabels-left">
  527. <table class="memname">
  528. <tr>
  529. <td class="memname">bool FatVolume::init </td>
  530. <td>(</td>
  531. <td class="paramtype">uint8_t&#160;</td>
  532. <td class="paramname"><em>part</em></td><td>)</td>
  533. <td></td>
  534. </tr>
  535. </table>
  536. </td>
  537. <td class="mlabels-right">
  538. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  539. </tr>
  540. </table>
  541. </div><div class="memdoc">
  542. <p>Initialize a FAT volume.</p>
  543. <dl class="params"><dt>Parameters</dt><dd>
  544. <table class="params">
  545. <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>
  546. </table>
  547. </dd>
  548. </dl>
  549. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>
  550. </div>
  551. </div>
  552. <a class="anchor" id="ab2d483670a0a6a6a4754b23614fe11bc"></a>
  553. <div class="memitem">
  554. <div class="memproto">
  555. <table class="mlabels">
  556. <tr>
  557. <td class="mlabels-left">
  558. <table class="memname">
  559. <tr>
  560. <td class="memname">uint16_t FatVolume::rootDirEntryCount </td>
  561. <td>(</td>
  562. <td class="paramname"></td><td>)</td>
  563. <td> const</td>
  564. </tr>
  565. </table>
  566. </td>
  567. <td class="mlabels-right">
  568. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  569. </tr>
  570. </table>
  571. </div><div class="memdoc">
  572. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  573. </div>
  574. </div>
  575. <a class="anchor" id="ae9363ebbbae90e895ea56e8fa3f60c13"></a>
  576. <div class="memitem">
  577. <div class="memproto">
  578. <table class="mlabels">
  579. <tr>
  580. <td class="mlabels-left">
  581. <table class="memname">
  582. <tr>
  583. <td class="memname">uint32_t FatVolume::rootDirStart </td>
  584. <td>(</td>
  585. <td class="paramname"></td><td>)</td>
  586. <td> const</td>
  587. </tr>
  588. </table>
  589. </td>
  590. <td class="mlabels-right">
  591. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  592. </tr>
  593. </table>
  594. </div><div class="memdoc">
  595. <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>
  596. </div>
  597. </div>
  598. <a class="anchor" id="a07bc98088ce4a9c725700899c184f7fc"></a>
  599. <div class="memitem">
  600. <div class="memproto">
  601. <table class="mlabels">
  602. <tr>
  603. <td class="mlabels-left">
  604. <table class="memname">
  605. <tr>
  606. <td class="memname">uint32_t FatVolume::volumeBlockCount </td>
  607. <td>(</td>
  608. <td class="paramname"></td><td>)</td>
  609. <td> const</td>
  610. </tr>
  611. </table>
  612. </td>
  613. <td class="mlabels-right">
  614. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
  615. </tr>
  616. </table>
  617. </div><div class="memdoc">
  618. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in the volume </dd></dl>
  619. </div>
  620. </div>
  621. <a class="anchor" id="a8088aa74cf601996905dadd2eea6966c"></a>
  622. <div class="memitem">
  623. <div class="memproto">
  624. <table class="mlabels">
  625. <tr>
  626. <td class="mlabels-left">
  627. <table class="memname">
  628. <tr>
  629. <td class="memname">bool FatVolume::wipe </td>
  630. <td>(</td>
  631. <td class="paramtype"><a class="el" href="_fat_volume_8h.html#ac62f6449331cfe1a71f29be30efe7890">print_t</a> *&#160;</td>
  632. <td class="paramname"><em>pr</em> = <code>0</code></td><td>)</td>
  633. <td></td>
  634. </tr>
  635. </table>
  636. </td>
  637. <td class="mlabels-right">
  638. <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
  639. </tr>
  640. </table>
  641. </div><div class="memdoc">
  642. <p>Wipe all data from the volume. </p><dl class="params"><dt>Parameters</dt><dd>
  643. <table class="params">
  644. <tr><td class="paramdir">[in]</td><td class="paramname">pr</td><td>print stream for status dots. </td></tr>
  645. </table>
  646. </dd>
  647. </dl>
  648. <dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
  649. </div>
  650. </div>
  651. <hr/>The documentation for this class was generated from the following file:<ul>
  652. <li>Arduino/libraries/SdFat/SdVolume.h</li>
  653. </ul>
  654. </div><!-- contents -->
  655. <!-- start footer part -->
  656. <hr class="footer"/><address class="footer"><small>
  657. Generated on Sun Feb 1 2015 10:21:40 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  658. <img class="footer" src="doxygen.png" alt="doxygen"/>
  659. </a> 1.8.8
  660. </small></address>
  661. </body>
  662. </html>