Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.

578 lines
25KB

  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.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: ExFatPartition Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.14 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#friends">Friends</a> &#124;
  65. <a href="class_ex_fat_partition-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">ExFatPartition Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Access exFat partitions on raw file devices.
  71. <a href="class_ex_fat_partition.html#details">More...</a></p>
  72. <p><code>#include &lt;ExFatPartition.h&gt;</code></p>
  73. <div class="dynheader">
  74. Inheritance diagram for ExFatPartition:</div>
  75. <div class="dyncontent">
  76. <div class="center"><img src="class_ex_fat_partition__inherit__graph.png" border="0" usemap="#_ex_fat_partition_inherit__map" alt="Inheritance graph"/></div>
  77. <map name="_ex_fat_partition_inherit__map" id="_ex_fat_partition_inherit__map">
  78. <area shape="rect" id="node2" href="class_ex_fat_volume.html" title="exFAT volume. " alt="" coords="40,80,141,107"/>
  79. <area shape="rect" id="node3" href="class_sd_base.html" title="SdBase\&lt; ExFatVolume \&gt;" alt="" coords="5,155,176,181"/>
  80. <area shape="rect" id="node4" href="class_sd_ex_fat.html" title="SD file system class for exFAT volumes. " alt="" coords="54,229,127,256"/>
  81. </map>
  82. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  85. Public Member Functions</h2></td></tr>
  86. <tr class="memitem:a1da789000f42592f9509df843fdd50c8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a1da789000f42592f9509df843fdd50c8">bytesPerCluster</a> ()</td></tr>
  87. <tr class="separator:a1da789000f42592f9509df843fdd50c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a64825a52f754bdcb02c8632f5fd15373"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a64825a52f754bdcb02c8632f5fd15373">bytesPerClusterShift</a> ()</td></tr>
  89. <tr class="separator:a64825a52f754bdcb02c8632f5fd15373"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:adea3221412eb4bf5c19b6311573135f8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#adea3221412eb4bf5c19b6311573135f8">bytesPerSector</a> ()</td></tr>
  91. <tr class="separator:adea3221412eb4bf5c19b6311573135f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a715f3574452c27ecf51b66208ce5e4a7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a715f3574452c27ecf51b66208ce5e4a7">bytesPerSectorShift</a> ()</td></tr>
  93. <tr class="separator:a715f3574452c27ecf51b66208ce5e4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a63fac808e421ed5c8e72a37616ac56ac"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a63fac808e421ed5c8e72a37616ac56ac">cacheClear</a> ()</td></tr>
  95. <tr class="separator:a63fac808e421ed5c8e72a37616ac56ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ac01eb583924286617b0ee8fcf7409ac0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#ac01eb583924286617b0ee8fcf7409ac0">clusterCount</a> ()</td></tr>
  97. <tr class="separator:ac01eb583924286617b0ee8fcf7409ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a58b96587b787f4164eb719913dfbaaf5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a58b96587b787f4164eb719913dfbaaf5">clusterHeapStartSector</a> ()</td></tr>
  99. <tr class="separator:a58b96587b787f4164eb719913dfbaaf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:aa7d1ae15168896ccc2648b4c383b34eb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#aa7d1ae15168896ccc2648b4c383b34eb">fatLength</a> ()</td></tr>
  101. <tr class="separator:aa7d1ae15168896ccc2648b4c383b34eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a9eff9e65b511ec06b62856bff8ed29eb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a9eff9e65b511ec06b62856bff8ed29eb">fatStartSector</a> ()</td></tr>
  103. <tr class="separator:a9eff9e65b511ec06b62856bff8ed29eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a3e63d87b4ef985f92c1793d269274f44"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a3e63d87b4ef985f92c1793d269274f44">fatType</a> () const</td></tr>
  105. <tr class="separator:a3e63d87b4ef985f92c1793d269274f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ae6d4414d6440b79b6314cd1edbaa35b0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#ae6d4414d6440b79b6314cd1edbaa35b0">freeClusterCount</a> ()</td></tr>
  107. <tr class="separator:ae6d4414d6440b79b6314cd1edbaa35b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:adb1d277492dccba09031e2064f4fa66f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#adb1d277492dccba09031e2064f4fa66f">init</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, uint8_t part)</td></tr>
  109. <tr class="separator:adb1d277492dccba09031e2064f4fa66f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a658c250984be29febf8f4d2a2ec312a1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a658c250984be29febf8f4d2a2ec312a1">rootDirectoryCluster</a> ()</td></tr>
  111. <tr class="separator:a658c250984be29febf8f4d2a2ec312a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a9412bd687edc99266c88f8aa87f01c51"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a9412bd687edc99266c88f8aa87f01c51">rootLength</a> ()</td></tr>
  113. <tr class="separator:a9412bd687edc99266c88f8aa87f01c51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:aaa7306ac8ff29f50ec4d919ccaff10d7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#aaa7306ac8ff29f50ec4d919ccaff10d7">sectorsPerCluster</a> ()</td></tr>
  115. <tr class="separator:aaa7306ac8ff29f50ec4d919ccaff10d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ab1624bf02690ee06365207cb8f1d48ac"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#ab1624bf02690ee06365207cb8f1d48ac">sectorsPerClusterShift</a> ()</td></tr>
  117. <tr class="separator:ab1624bf02690ee06365207cb8f1d48ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  120. Friends</h2></td></tr>
  121. <tr class="memitem:a0ea68fb710b4ca007419acbf84ca6908"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ex_fat_partition.html#a0ea68fb710b4ca007419acbf84ca6908">ExFatFile</a></td></tr>
  122. <tr class="separator:a0ea68fb710b4ca007419acbf84ca6908"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table>
  124. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  125. <div class="textblock"><p>Access exFat partitions on raw file devices. </p>
  126. </div><h2 class="groupheader">Member Function Documentation</h2>
  127. <a id="a1da789000f42592f9509df843fdd50c8"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#a1da789000f42592f9509df843fdd50c8">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="mlabels">
  132. <tr>
  133. <td class="mlabels-left">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">uint32_t ExFatPartition::bytesPerCluster </td>
  137. <td>(</td>
  138. <td class="paramname"></td><td>)</td>
  139. <td></td>
  140. </tr>
  141. </table>
  142. </td>
  143. <td class="mlabels-right">
  144. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a cluster. </dd></dl>
  149. </div>
  150. </div>
  151. <a id="a64825a52f754bdcb02c8632f5fd15373"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a64825a52f754bdcb02c8632f5fd15373">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">uint8_t ExFatPartition::bytesPerClusterShift </td>
  161. <td>(</td>
  162. <td class="paramname"></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </td>
  167. <td class="mlabels-right">
  168. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerCluster. </dd></dl>
  173. </div>
  174. </div>
  175. <a id="adea3221412eb4bf5c19b6311573135f8"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#adea3221412eb4bf5c19b6311573135f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="mlabels">
  180. <tr>
  181. <td class="mlabels-left">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">uint16_t ExFatPartition::bytesPerSector </td>
  185. <td>(</td>
  186. <td class="paramname"></td><td>)</td>
  187. <td></td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a sector. </dd></dl>
  197. </div>
  198. </div>
  199. <a id="a715f3574452c27ecf51b66208ce5e4a7"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#a715f3574452c27ecf51b66208ce5e4a7">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">uint8_t ExFatPartition::bytesPerSectorShift </td>
  209. <td>(</td>
  210. <td class="paramname"></td><td>)</td>
  211. <td></td>
  212. </tr>
  213. </table>
  214. </td>
  215. <td class="mlabels-right">
  216. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerSector. </dd></dl>
  221. </div>
  222. </div>
  223. <a id="a63fac808e421ed5c8e72a37616ac56ac"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#a63fac808e421ed5c8e72a37616ac56ac">&#9670;&nbsp;</a></span>cacheClear()</h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="mlabels">
  228. <tr>
  229. <td class="mlabels-left">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">uint8_t* ExFatPartition::cacheClear </td>
  233. <td>(</td>
  234. <td class="paramname"></td><td>)</td>
  235. <td></td>
  236. </tr>
  237. </table>
  238. </td>
  239. <td class="mlabels-right">
  240. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  241. </tr>
  242. </table>
  243. </div><div class="memdoc">
  244. <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>
  245. </div>
  246. </div>
  247. <a id="ac01eb583924286617b0ee8fcf7409ac0"></a>
  248. <h2 class="memtitle"><span class="permalink"><a href="#ac01eb583924286617b0ee8fcf7409ac0">&#9670;&nbsp;</a></span>clusterCount()</h2>
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="mlabels">
  252. <tr>
  253. <td class="mlabels-left">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">uint32_t ExFatPartition::clusterCount </td>
  257. <td>(</td>
  258. <td class="paramname"></td><td>)</td>
  259. <td></td>
  260. </tr>
  261. </table>
  262. </td>
  263. <td class="mlabels-right">
  264. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <dl class="section return"><dt>Returns</dt><dd>the cluster count for the partition. </dd></dl>
  269. </div>
  270. </div>
  271. <a id="a58b96587b787f4164eb719913dfbaaf5"></a>
  272. <h2 class="memtitle"><span class="permalink"><a href="#a58b96587b787f4164eb719913dfbaaf5">&#9670;&nbsp;</a></span>clusterHeapStartSector()</h2>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="mlabels">
  276. <tr>
  277. <td class="mlabels-left">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">uint32_t ExFatPartition::clusterHeapStartSector </td>
  281. <td>(</td>
  282. <td class="paramname"></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </td>
  287. <td class="mlabels-right">
  288. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <dl class="section return"><dt>Returns</dt><dd>the cluster heap start sector. </dd></dl>
  293. </div>
  294. </div>
  295. <a id="aa7d1ae15168896ccc2648b4c383b34eb"></a>
  296. <h2 class="memtitle"><span class="permalink"><a href="#aa7d1ae15168896ccc2648b4c383b34eb">&#9670;&nbsp;</a></span>fatLength()</h2>
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="mlabels">
  300. <tr>
  301. <td class="mlabels-left">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname">uint32_t ExFatPartition::fatLength </td>
  305. <td>(</td>
  306. <td class="paramname"></td><td>)</td>
  307. <td></td>
  308. </tr>
  309. </table>
  310. </td>
  311. <td class="mlabels-right">
  312. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <dl class="section return"><dt>Returns</dt><dd>the FAT length in sectors </dd></dl>
  317. </div>
  318. </div>
  319. <a id="a9eff9e65b511ec06b62856bff8ed29eb"></a>
  320. <h2 class="memtitle"><span class="permalink"><a href="#a9eff9e65b511ec06b62856bff8ed29eb">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="mlabels">
  324. <tr>
  325. <td class="mlabels-left">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">uint32_t ExFatPartition::fatStartSector </td>
  329. <td>(</td>
  330. <td class="paramname"></td><td>)</td>
  331. <td></td>
  332. </tr>
  333. </table>
  334. </td>
  335. <td class="mlabels-right">
  336. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <dl class="section return"><dt>Returns</dt><dd>the FAT start sector number. </dd></dl>
  341. </div>
  342. </div>
  343. <a id="a3e63d87b4ef985f92c1793d269274f44"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a3e63d87b4ef985f92c1793d269274f44">&#9670;&nbsp;</a></span>fatType()</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="mlabels">
  348. <tr>
  349. <td class="mlabels-left">
  350. <table class="memname">
  351. <tr>
  352. <td class="memname">uint8_t ExFatPartition::fatType </td>
  353. <td>(</td>
  354. <td class="paramname"></td><td>)</td>
  355. <td> const</td>
  356. </tr>
  357. </table>
  358. </td>
  359. <td class="mlabels-right">
  360. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  361. </tr>
  362. </table>
  363. </div><div class="memdoc">
  364. <dl class="section return"><dt>Returns</dt><dd>Type FAT_TYPE_EXFAT for exFAT partition or zero for error. </dd></dl>
  365. </div>
  366. </div>
  367. <a id="ae6d4414d6440b79b6314cd1edbaa35b0"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#ae6d4414d6440b79b6314cd1edbaa35b0">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">uint32_t ExFatPartition::freeClusterCount </td>
  374. <td>(</td>
  375. <td class="paramname"></td><td>)</td>
  376. <td></td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <dl class="section return"><dt>Returns</dt><dd>the free cluster count. </dd></dl>
  381. </div>
  382. </div>
  383. <a id="adb1d277492dccba09031e2064f4fa66f"></a>
  384. <h2 class="memtitle"><span class="permalink"><a href="#adb1d277492dccba09031e2064f4fa66f">&#9670;&nbsp;</a></span>init()</h2>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">bool ExFatPartition::init </td>
  390. <td>(</td>
  391. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  392. <td class="paramname"><em>dev</em>, </td>
  393. </tr>
  394. <tr>
  395. <td class="paramkey"></td>
  396. <td></td>
  397. <td class="paramtype">uint8_t&#160;</td>
  398. <td class="paramname"><em>part</em>&#160;</td>
  399. </tr>
  400. <tr>
  401. <td></td>
  402. <td>)</td>
  403. <td></td><td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>Initialize a exFAT partition. </p><dl class="params"><dt>Parameters</dt><dd>
  408. <table class="params">
  409. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The blockDevice for the partition. </td></tr>
  410. <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 sector zero.</td></tr>
  411. </table>
  412. </dd>
  413. </dl>
  414. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  415. </div>
  416. </div>
  417. <a id="a658c250984be29febf8f4d2a2ec312a1"></a>
  418. <h2 class="memtitle"><span class="permalink"><a href="#a658c250984be29febf8f4d2a2ec312a1">&#9670;&nbsp;</a></span>rootDirectoryCluster()</h2>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">uint32_t ExFatPartition::rootDirectoryCluster </td>
  427. <td>(</td>
  428. <td class="paramname"></td><td>)</td>
  429. <td></td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <dl class="section return"><dt>Returns</dt><dd>the root directory start cluster number. </dd></dl>
  439. </div>
  440. </div>
  441. <a id="a9412bd687edc99266c88f8aa87f01c51"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#a9412bd687edc99266c88f8aa87f01c51">&#9670;&nbsp;</a></span>rootLength()</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname">uint32_t ExFatPartition::rootLength </td>
  448. <td>(</td>
  449. <td class="paramname"></td><td>)</td>
  450. <td></td>
  451. </tr>
  452. </table>
  453. </div><div class="memdoc">
  454. <dl class="section return"><dt>Returns</dt><dd>the root directory length. </dd></dl>
  455. </div>
  456. </div>
  457. <a id="aaa7306ac8ff29f50ec4d919ccaff10d7"></a>
  458. <h2 class="memtitle"><span class="permalink"><a href="#aaa7306ac8ff29f50ec4d919ccaff10d7">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="mlabels">
  462. <tr>
  463. <td class="mlabels-left">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname">uint32_t ExFatPartition::sectorsPerCluster </td>
  467. <td>(</td>
  468. <td class="paramname"></td><td>)</td>
  469. <td></td>
  470. </tr>
  471. </table>
  472. </td>
  473. <td class="mlabels-right">
  474. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. <dl class="section return"><dt>Returns</dt><dd>the number of sectors in a cluster. </dd></dl>
  479. </div>
  480. </div>
  481. <a id="ab1624bf02690ee06365207cb8f1d48ac"></a>
  482. <h2 class="memtitle"><span class="permalink"><a href="#ab1624bf02690ee06365207cb8f1d48ac">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="mlabels">
  486. <tr>
  487. <td class="mlabels-left">
  488. <table class="memname">
  489. <tr>
  490. <td class="memname">uint8_t ExFatPartition::sectorsPerClusterShift </td>
  491. <td>(</td>
  492. <td class="paramname"></td><td>)</td>
  493. <td></td>
  494. </tr>
  495. </table>
  496. </td>
  497. <td class="mlabels-right">
  498. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  499. </tr>
  500. </table>
  501. </div><div class="memdoc">
  502. <dl class="section return"><dt>Returns</dt><dd>the power of two for sectors per cluster. </dd></dl>
  503. </div>
  504. </div>
  505. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  506. <a id="a0ea68fb710b4ca007419acbf84ca6908"></a>
  507. <h2 class="memtitle"><span class="permalink"><a href="#a0ea68fb710b4ca007419acbf84ca6908">&#9670;&nbsp;</a></span>ExFatFile</h2>
  508. <div class="memitem">
  509. <div class="memproto">
  510. <table class="mlabels">
  511. <tr>
  512. <td class="mlabels-left">
  513. <table class="memname">
  514. <tr>
  515. <td class="memname">friend class <a class="el" href="class_ex_fat_file.html">ExFatFile</a></td>
  516. </tr>
  517. </table>
  518. </td>
  519. <td class="mlabels-right">
  520. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  521. </tr>
  522. </table>
  523. </div><div class="memdoc">
  524. <p><a class="el" href="class_ex_fat_file.html" title="Basic file class. ">ExFatFile</a> allowed access to private members. </p>
  525. </div>
  526. </div>
  527. <hr/>The documentation for this class was generated from the following files:<ul>
  528. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_partition_8h.html">ExFatPartition.h</a></li>
  529. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatPartition.cpp</li>
  530. </ul>
  531. </div><!-- contents -->
  532. <!-- start footer part -->
  533. <hr class="footer"/><address class="footer"><small>
  534. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  535. <img class="footer" src="doxygen.png" alt="doxygen"/>
  536. </a> 1.8.14
  537. </small></address>
  538. </body>
  539. </html>