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.

преди 10 години
преди 10 години
преди 10 години
преди 10 години
преди 10 години
преди 10 години
преди 10 години
преди 10 години
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557
  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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">SdFat
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.8 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  33. <li><a href="files.html"><span>Files</span></a></li>
  34. </ul>
  35. </div>
  36. <div id="navrow2" class="tabs2">
  37. <ul class="tablist">
  38. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  39. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  40. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  41. </ul>
  42. </div>
  43. </div><!-- top -->
  44. <div class="header">
  45. <div class="summary">
  46. <a href="#pub-methods">Public Member Functions</a> &#124;
  47. <a href="#friends">Friends</a> &#124;
  48. <a href="class_sd_volume-members.html">List of all members</a> </div>
  49. <div class="headertitle">
  50. <div class="title">SdVolume Class Reference</div> </div>
  51. </div><!--header-->
  52. <div class="contents">
  53. <p>Access FAT16 and FAT32 volumes on SD and SDHC cards.
  54. <a href="class_sd_volume.html#details">More...</a></p>
  55. <p><code>#include &lt;SdVolume.h&gt;</code></p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:affab4c57c98e41ee55b21c87f814804b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#affab4c57c98e41ee55b21c87f814804b">blocksPerCluster</a> () const </td></tr>
  60. <tr class="separator:affab4c57c98e41ee55b21c87f814804b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a87ed6542db9642ffa106def897a368c6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a87ed6542db9642ffa106def897a368c6">blocksPerFat</a> () const </td></tr>
  62. <tr class="separator:a87ed6542db9642ffa106def897a368c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:adaecef65fdf94d323597a461eb641f5e"><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_sd_volume.html#adaecef65fdf94d323597a461eb641f5e">cacheClear</a> ()</td></tr>
  64. <tr class="separator:adaecef65fdf94d323597a461eb641f5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a323adfb5ac395b769f30c31ce2618f22"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a323adfb5ac395b769f30c31ce2618f22">clusterCount</a> () const </td></tr>
  66. <tr class="separator:a323adfb5ac395b769f30c31ce2618f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a50c8e198feb63b0ca26737f91bd3e139"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a50c8e198feb63b0ca26737f91bd3e139">clusterSizeShift</a> () const </td></tr>
  68. <tr class="separator:a50c8e198feb63b0ca26737f91bd3e139"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a99ca71035785948c42ade0863f91c9ab"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a99ca71035785948c42ade0863f91c9ab">dataStartBlock</a> () const </td></tr>
  70. <tr class="separator:a99ca71035785948c42ade0863f91c9ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a4dbcb7b34a83468b1c6f8c4556393526"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a4dbcb7b34a83468b1c6f8c4556393526">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  72. <tr class="separator:a4dbcb7b34a83468b1c6f8c4556393526"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a5d4307584ef14e4a2fef85b4954b1aa2"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a5d4307584ef14e4a2fef85b4954b1aa2">fatCount</a> () const </td></tr>
  74. <tr class="separator:a5d4307584ef14e4a2fef85b4954b1aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a9032ec5d3323ee67477c6bbf39821415"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a9032ec5d3323ee67477c6bbf39821415">fatStartBlock</a> () const </td></tr>
  76. <tr class="separator:a9032ec5d3323ee67477c6bbf39821415"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a3f7b12db1e9ec4b847cd41fbe46b7baf"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a3f7b12db1e9ec4b847cd41fbe46b7baf">fatType</a> () const </td></tr>
  78. <tr class="separator:a3f7b12db1e9ec4b847cd41fbe46b7baf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a162efe707ab46847202300cb38739629"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a162efe707ab46847202300cb38739629">freeClusterCount</a> ()</td></tr>
  80. <tr class="separator:a162efe707ab46847202300cb38739629"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <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>
  82. <tr class="separator:a0ac221eda119ddccae8ac6bc20a4b12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <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>
  84. <tr class="separator:ae820ee8d9ea7ed01ce72ae3508a63cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a8573884a8056ab7c4c0d6e442f676cc4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a8573884a8056ab7c4c0d6e442f676cc4">rootDirEntryCount</a> () const </td></tr>
  86. <tr class="separator:a8573884a8056ab7c4c0d6e442f676cc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:aa1479f90c53bc9eac379664c5233d399"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#aa1479f90c53bc9eac379664c5233d399">rootDirStart</a> () const </td></tr>
  88. <tr class="separator:aa1479f90c53bc9eac379664c5233d399"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:afe76a9f7c181458995518dc8530a1fad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#afe76a9f7c181458995518dc8530a1fad">sdCard</a> ()</td></tr>
  90. <tr class="separator:afe76a9f7c181458995518dc8530a1fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a30d4489087fbdce20b8fe1a624dbe658"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a30d4489087fbdce20b8fe1a624dbe658">SdVolume</a> ()</td></tr>
  92. <tr class="separator:a30d4489087fbdce20b8fe1a624dbe658"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table><table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  95. Friends</h2></td></tr>
  96. <tr class="memitem:a05e466c179d34fec11c4406677fe0533"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05e466c179d34fec11c4406677fe0533"></a>
  97. class&#160;</td><td class="memItemRight" valign="bottom"><b>SdBaseFile</b></td></tr>
  98. <tr class="separator:a05e466c179d34fec11c4406677fe0533"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <div class="textblock"><p>Access FAT16 and FAT32 volumes on SD and SDHC cards. </p>
  102. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  103. <a class="anchor" id="a30d4489087fbdce20b8fe1a624dbe658"></a>
  104. <div class="memitem">
  105. <div class="memproto">
  106. <table class="mlabels">
  107. <tr>
  108. <td class="mlabels-left">
  109. <table class="memname">
  110. <tr>
  111. <td class="memname">SdVolume::SdVolume </td>
  112. <td>(</td>
  113. <td class="paramname"></td><td>)</td>
  114. <td></td>
  115. </tr>
  116. </table>
  117. </td>
  118. <td class="mlabels-right">
  119. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Create an instance of <a class="el" href="class_sd_volume.html" title="Access FAT16 and FAT32 volumes on SD and SDHC cards. ">SdVolume</a> </p>
  124. </div>
  125. </div>
  126. <h2 class="groupheader">Member Function Documentation</h2>
  127. <a class="anchor" id="affab4c57c98e41ee55b21c87f814804b"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="mlabels">
  131. <tr>
  132. <td class="mlabels-left">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">uint8_t SdVolume::blocksPerCluster </td>
  136. <td>(</td>
  137. <td class="paramname"></td><td>)</td>
  138. <td> const</td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>
  148. </div>
  149. </div>
  150. <a class="anchor" id="a87ed6542db9642ffa106def897a368c6"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="mlabels">
  154. <tr>
  155. <td class="mlabels-left">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">uint32_t SdVolume::blocksPerFat </td>
  159. <td>(</td>
  160. <td class="paramname"></td><td>)</td>
  161. <td> const</td>
  162. </tr>
  163. </table>
  164. </td>
  165. <td class="mlabels-right">
  166. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  171. </div>
  172. </div>
  173. <a class="anchor" id="adaecef65fdf94d323597a461eb641f5e"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="mlabels">
  177. <tr>
  178. <td class="mlabels-left">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* SdVolume::cacheClear </td>
  182. <td>(</td>
  183. <td class="paramname"></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Clear the cache and returns a pointer to the cache. Used by the WaveRP recorder to do raw write to the SD card. 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>
  194. </div>
  195. </div>
  196. <a class="anchor" id="a323adfb5ac395b769f30c31ce2618f22"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="mlabels">
  200. <tr>
  201. <td class="mlabels-left">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">uint32_t SdVolume::clusterCount </td>
  205. <td>(</td>
  206. <td class="paramname"></td><td>)</td>
  207. <td> const</td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  217. </div>
  218. </div>
  219. <a class="anchor" id="a50c8e198feb63b0ca26737f91bd3e139"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="mlabels">
  223. <tr>
  224. <td class="mlabels-left">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">uint8_t SdVolume::clusterSizeShift </td>
  228. <td>(</td>
  229. <td class="paramname"></td><td>)</td>
  230. <td> const</td>
  231. </tr>
  232. </table>
  233. </td>
  234. <td class="mlabels-right">
  235. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>
  240. </div>
  241. </div>
  242. <a class="anchor" id="a99ca71035785948c42ade0863f91c9ab"></a>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="mlabels">
  246. <tr>
  247. <td class="mlabels-left">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">uint32_t SdVolume::dataStartBlock </td>
  251. <td>(</td>
  252. <td class="paramname"></td><td>)</td>
  253. <td> const</td>
  254. </tr>
  255. </table>
  256. </td>
  257. <td class="mlabels-right">
  258. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  263. </div>
  264. </div>
  265. <a class="anchor" id="a4dbcb7b34a83468b1c6f8c4556393526"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="mlabels">
  269. <tr>
  270. <td class="mlabels-left">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">bool SdVolume::dbgFat </td>
  274. <td>(</td>
  275. <td class="paramtype">uint32_t&#160;</td>
  276. <td class="paramname"><em>n</em>, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype">uint32_t *&#160;</td>
  282. <td class="paramname"><em>v</em>&#160;</td>
  283. </tr>
  284. <tr>
  285. <td></td>
  286. <td>)</td>
  287. <td></td><td></td>
  288. </tr>
  289. </table>
  290. </td>
  291. <td class="mlabels-right">
  292. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Debug access to FAT table</p>
  297. <dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  300. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  301. </table>
  302. </dd>
  303. </dl>
  304. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>
  305. </div>
  306. </div>
  307. <a class="anchor" id="a5d4307584ef14e4a2fef85b4954b1aa2"></a>
  308. <div class="memitem">
  309. <div class="memproto">
  310. <table class="mlabels">
  311. <tr>
  312. <td class="mlabels-left">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">uint8_t SdVolume::fatCount </td>
  316. <td>(</td>
  317. <td class="paramname"></td><td>)</td>
  318. <td> const</td>
  319. </tr>
  320. </table>
  321. </td>
  322. <td class="mlabels-right">
  323. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <dl class="section return"><dt>Returns</dt><dd>The number of FAT structures on the volume. </dd></dl>
  328. </div>
  329. </div>
  330. <a class="anchor" id="a9032ec5d3323ee67477c6bbf39821415"></a>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="mlabels">
  334. <tr>
  335. <td class="mlabels-left">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">uint32_t SdVolume::fatStartBlock </td>
  339. <td>(</td>
  340. <td class="paramname"></td><td>)</td>
  341. <td> const</td>
  342. </tr>
  343. </table>
  344. </td>
  345. <td class="mlabels-right">
  346. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  351. </div>
  352. </div>
  353. <a class="anchor" id="a3f7b12db1e9ec4b847cd41fbe46b7baf"></a>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="mlabels">
  357. <tr>
  358. <td class="mlabels-left">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname">uint8_t SdVolume::fatType </td>
  362. <td>(</td>
  363. <td class="paramname"></td><td>)</td>
  364. <td> const</td>
  365. </tr>
  366. </table>
  367. </td>
  368. <td class="mlabels-right">
  369. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  374. </div>
  375. </div>
  376. <a class="anchor" id="a162efe707ab46847202300cb38739629"></a>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">int32_t SdVolume::freeClusterCount </td>
  382. <td>(</td>
  383. <td class="paramname"></td><td>)</td>
  384. <td></td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Volume free space in clusters.</p>
  389. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  390. </div>
  391. </div>
  392. <a class="anchor" id="a0ac221eda119ddccae8ac6bc20a4b12d"></a>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="mlabels">
  396. <tr>
  397. <td class="mlabels-left">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">bool SdVolume::init </td>
  401. <td>(</td>
  402. <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>
  403. <td class="paramname"><em>dev</em></td><td>)</td>
  404. <td></td>
  405. </tr>
  406. </table>
  407. </td>
  408. <td class="mlabels-right">
  409. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  414. <dl class="params"><dt>Parameters</dt><dd>
  415. <table class="params">
  416. <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 flash memory cards. ">Sd2Card</a> where the volume is located.</td></tr>
  417. </table>
  418. </dd>
  419. </dl>
  420. <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>
  421. </div>
  422. </div>
  423. <a class="anchor" id="ae820ee8d9ea7ed01ce72ae3508a63cbf"></a>
  424. <div class="memitem">
  425. <div class="memproto">
  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>
  432. </tr>
  433. <tr>
  434. <td class="paramkey"></td>
  435. <td></td>
  436. <td class="paramtype">uint8_t&#160;</td>
  437. <td class="paramname"><em>part</em>&#160;</td>
  438. </tr>
  439. <tr>
  440. <td></td>
  441. <td>)</td>
  442. <td></td><td></td>
  443. </tr>
  444. </table>
  445. </div><div class="memdoc">
  446. <p>Initialize a FAT volume.</p>
  447. <dl class="params"><dt>Parameters</dt><dd>
  448. <table class="params">
  449. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The SD card where the volume is located.</td></tr>
  450. <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>
  451. </table>
  452. </dd>
  453. </dl>
  454. <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>
  455. </div>
  456. </div>
  457. <a class="anchor" id="a8573884a8056ab7c4c0d6e442f676cc4"></a>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="mlabels">
  461. <tr>
  462. <td class="mlabels-left">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname">uint32_t SdVolume::rootDirEntryCount </td>
  466. <td>(</td>
  467. <td class="paramname"></td><td>)</td>
  468. <td> const</td>
  469. </tr>
  470. </table>
  471. </td>
  472. <td class="mlabels-right">
  473. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  474. </tr>
  475. </table>
  476. </div><div class="memdoc">
  477. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  478. </div>
  479. </div>
  480. <a class="anchor" id="aa1479f90c53bc9eac379664c5233d399"></a>
  481. <div class="memitem">
  482. <div class="memproto">
  483. <table class="mlabels">
  484. <tr>
  485. <td class="mlabels-left">
  486. <table class="memname">
  487. <tr>
  488. <td class="memname">uint32_t SdVolume::rootDirStart </td>
  489. <td>(</td>
  490. <td class="paramname"></td><td>)</td>
  491. <td> const</td>
  492. </tr>
  493. </table>
  494. </td>
  495. <td class="mlabels-right">
  496. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  497. </tr>
  498. </table>
  499. </div><div class="memdoc">
  500. <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>
  501. </div>
  502. </div>
  503. <a class="anchor" id="afe76a9f7c181458995518dc8530a1fad"></a>
  504. <div class="memitem">
  505. <div class="memproto">
  506. <table class="mlabels">
  507. <tr>
  508. <td class="mlabels-left">
  509. <table class="memname">
  510. <tr>
  511. <td class="memname"><a class="el" href="class_sd2_card.html">Sd2Card</a>* SdVolume::sdCard </td>
  512. <td>(</td>
  513. <td class="paramname"></td><td>)</td>
  514. <td></td>
  515. </tr>
  516. </table>
  517. </td>
  518. <td class="mlabels-right">
  519. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  520. </tr>
  521. </table>
  522. </div><div class="memdoc">
  523. <p><a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC flash memory cards. ">Sd2Card</a> object for this volume </p><dl class="section return"><dt>Returns</dt><dd>pointer to <a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC flash memory cards. ">Sd2Card</a> object. </dd></dl>
  524. </div>
  525. </div>
  526. <hr/>The documentation for this class was generated from the following files:<ul>
  527. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_volume_8h.html">SdVolume.h</a></li>
  528. <li>Arduino/libraries/SdFat/SdVolume.cpp</li>
  529. </ul>
  530. </div><!-- contents -->
  531. <!-- start footer part -->
  532. <hr class="footer"/><address class="footer"><small>
  533. Generated on Sat Oct 25 2014 07:56:23 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  534. <img class="footer" src="doxygen.png" alt="doxygen"/>
  535. </a> 1.8.8
  536. </small></address>
  537. </body>
  538. </html>