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.

class_ex_fat_partition.html 25KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>
  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.16 -->
  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" title="Access exFat partitions on raw file devices." alt="" coords="38,5,143,32"/>
  79. <area shape="rect" href="class_ex_fat_volume.html" title="exFAT volume." alt="" coords="40,80,141,107"/>
  80. <area shape="rect" href="class_sd_base.html" title=" " alt="" coords="5,155,176,181"/>
  81. <area shape="rect" href="class_sd_ex_fat.html" title="SD file system class for exFAT volumes." alt="" coords="54,229,127,256"/>
  82. </map>
  83. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  86. Public Member Functions</h2></td></tr>
  87. <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>
  88. <tr class="separator:a1da789000f42592f9509df843fdd50c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <tr class="separator:a64825a52f754bdcb02c8632f5fd15373"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <tr class="separator:adea3221412eb4bf5c19b6311573135f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="separator:a715f3574452c27ecf51b66208ce5e4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="separator:a63fac808e421ed5c8e72a37616ac56ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:ac01eb583924286617b0ee8fcf7409ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <tr class="separator:a58b96587b787f4164eb719913dfbaaf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="separator:aa7d1ae15168896ccc2648b4c383b34eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:a9eff9e65b511ec06b62856bff8ed29eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:a3e63d87b4ef985f92c1793d269274f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:ae6d4414d6440b79b6314cd1edbaa35b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:adb1d277492dccba09031e2064f4fa66f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:a658c250984be29febf8f4d2a2ec312a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a9412bd687edc99266c88f8aa87f01c51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:aaa7306ac8ff29f50ec4d919ccaff10d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:ab1624bf02690ee06365207cb8f1d48ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table><table class="memberdecls">
  120. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  121. Friends</h2></td></tr>
  122. <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>
  123. <tr class="separator:a0ea68fb710b4ca007419acbf84ca6908"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table>
  125. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  126. <div class="textblock"><p>Access exFat partitions on raw file devices. </p>
  127. </div><h2 class="groupheader">Member Function Documentation</h2>
  128. <a id="a1da789000f42592f9509df843fdd50c8"></a>
  129. <h2 class="memtitle"><span class="permalink"><a href="#a1da789000f42592f9509df843fdd50c8">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="mlabels">
  133. <tr>
  134. <td class="mlabels-left">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">uint32_t ExFatPartition::bytesPerCluster </td>
  138. <td>(</td>
  139. <td class="paramname"></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </td>
  144. <td class="mlabels-right">
  145. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a cluster. </dd></dl>
  150. </div>
  151. </div>
  152. <a id="a64825a52f754bdcb02c8632f5fd15373"></a>
  153. <h2 class="memtitle"><span class="permalink"><a href="#a64825a52f754bdcb02c8632f5fd15373">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="mlabels">
  157. <tr>
  158. <td class="mlabels-left">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">uint8_t ExFatPartition::bytesPerClusterShift </td>
  162. <td>(</td>
  163. <td class="paramname"></td><td>)</td>
  164. <td></td>
  165. </tr>
  166. </table>
  167. </td>
  168. <td class="mlabels-right">
  169. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerCluster. </dd></dl>
  174. </div>
  175. </div>
  176. <a id="adea3221412eb4bf5c19b6311573135f8"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#adea3221412eb4bf5c19b6311573135f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">uint16_t ExFatPartition::bytesPerSector </td>
  186. <td>(</td>
  187. <td class="paramname"></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a sector. </dd></dl>
  198. </div>
  199. </div>
  200. <a id="a715f3574452c27ecf51b66208ce5e4a7"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#a715f3574452c27ecf51b66208ce5e4a7">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">uint8_t ExFatPartition::bytesPerSectorShift </td>
  210. <td>(</td>
  211. <td class="paramname"></td><td>)</td>
  212. <td></td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerSector. </dd></dl>
  222. </div>
  223. </div>
  224. <a id="a63fac808e421ed5c8e72a37616ac56ac"></a>
  225. <h2 class="memtitle"><span class="permalink"><a href="#a63fac808e421ed5c8e72a37616ac56ac">&#9670;&nbsp;</a></span>cacheClear()</h2>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="mlabels">
  229. <tr>
  230. <td class="mlabels-left">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">uint8_t* ExFatPartition::cacheClear </td>
  234. <td>(</td>
  235. <td class="paramname"></td><td>)</td>
  236. <td></td>
  237. </tr>
  238. </table>
  239. </td>
  240. <td class="mlabels-right">
  241. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <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>
  246. </div>
  247. </div>
  248. <a id="ac01eb583924286617b0ee8fcf7409ac0"></a>
  249. <h2 class="memtitle"><span class="permalink"><a href="#ac01eb583924286617b0ee8fcf7409ac0">&#9670;&nbsp;</a></span>clusterCount()</h2>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">uint32_t ExFatPartition::clusterCount </td>
  258. <td>(</td>
  259. <td class="paramname"></td><td>)</td>
  260. <td></td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <dl class="section return"><dt>Returns</dt><dd>the cluster count for the partition. </dd></dl>
  270. </div>
  271. </div>
  272. <a id="a58b96587b787f4164eb719913dfbaaf5"></a>
  273. <h2 class="memtitle"><span class="permalink"><a href="#a58b96587b787f4164eb719913dfbaaf5">&#9670;&nbsp;</a></span>clusterHeapStartSector()</h2>
  274. <div class="memitem">
  275. <div class="memproto">
  276. <table class="mlabels">
  277. <tr>
  278. <td class="mlabels-left">
  279. <table class="memname">
  280. <tr>
  281. <td class="memname">uint32_t ExFatPartition::clusterHeapStartSector </td>
  282. <td>(</td>
  283. <td class="paramname"></td><td>)</td>
  284. <td></td>
  285. </tr>
  286. </table>
  287. </td>
  288. <td class="mlabels-right">
  289. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <dl class="section return"><dt>Returns</dt><dd>the cluster heap start sector. </dd></dl>
  294. </div>
  295. </div>
  296. <a id="aa7d1ae15168896ccc2648b4c383b34eb"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#aa7d1ae15168896ccc2648b4c383b34eb">&#9670;&nbsp;</a></span>fatLength()</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">uint32_t ExFatPartition::fatLength </td>
  306. <td>(</td>
  307. <td class="paramname"></td><td>)</td>
  308. <td></td>
  309. </tr>
  310. </table>
  311. </td>
  312. <td class="mlabels-right">
  313. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <dl class="section return"><dt>Returns</dt><dd>the FAT length in sectors </dd></dl>
  318. </div>
  319. </div>
  320. <a id="a9eff9e65b511ec06b62856bff8ed29eb"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#a9eff9e65b511ec06b62856bff8ed29eb">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <table class="mlabels">
  325. <tr>
  326. <td class="mlabels-left">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">uint32_t ExFatPartition::fatStartSector </td>
  330. <td>(</td>
  331. <td class="paramname"></td><td>)</td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </td>
  336. <td class="mlabels-right">
  337. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <dl class="section return"><dt>Returns</dt><dd>the FAT start sector number. </dd></dl>
  342. </div>
  343. </div>
  344. <a id="a3e63d87b4ef985f92c1793d269274f44"></a>
  345. <h2 class="memtitle"><span class="permalink"><a href="#a3e63d87b4ef985f92c1793d269274f44">&#9670;&nbsp;</a></span>fatType()</h2>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="mlabels">
  349. <tr>
  350. <td class="mlabels-left">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">uint8_t ExFatPartition::fatType </td>
  354. <td>(</td>
  355. <td class="paramname"></td><td>)</td>
  356. <td> const</td>
  357. </tr>
  358. </table>
  359. </td>
  360. <td class="mlabels-right">
  361. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <dl class="section return"><dt>Returns</dt><dd>Type FAT_TYPE_EXFAT for exFAT partition or zero for error. </dd></dl>
  366. </div>
  367. </div>
  368. <a id="ae6d4414d6440b79b6314cd1edbaa35b0"></a>
  369. <h2 class="memtitle"><span class="permalink"><a href="#ae6d4414d6440b79b6314cd1edbaa35b0">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  370. <div class="memitem">
  371. <div class="memproto">
  372. <table class="memname">
  373. <tr>
  374. <td class="memname">uint32_t ExFatPartition::freeClusterCount </td>
  375. <td>(</td>
  376. <td class="paramname"></td><td>)</td>
  377. <td></td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <dl class="section return"><dt>Returns</dt><dd>the free cluster count. </dd></dl>
  382. </div>
  383. </div>
  384. <a id="adb1d277492dccba09031e2064f4fa66f"></a>
  385. <h2 class="memtitle"><span class="permalink"><a href="#adb1d277492dccba09031e2064f4fa66f">&#9670;&nbsp;</a></span>init()</h2>
  386. <div class="memitem">
  387. <div class="memproto">
  388. <table class="memname">
  389. <tr>
  390. <td class="memname">bool ExFatPartition::init </td>
  391. <td>(</td>
  392. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  393. <td class="paramname"><em>dev</em>, </td>
  394. </tr>
  395. <tr>
  396. <td class="paramkey"></td>
  397. <td></td>
  398. <td class="paramtype">uint8_t&#160;</td>
  399. <td class="paramname"><em>part</em>&#160;</td>
  400. </tr>
  401. <tr>
  402. <td></td>
  403. <td>)</td>
  404. <td></td><td></td>
  405. </tr>
  406. </table>
  407. </div><div class="memdoc">
  408. <p>Initialize a exFAT partition. </p><dl class="params"><dt>Parameters</dt><dd>
  409. <table class="params">
  410. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The blockDevice for the partition. </td></tr>
  411. <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>
  412. </table>
  413. </dd>
  414. </dl>
  415. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  416. </div>
  417. </div>
  418. <a id="a658c250984be29febf8f4d2a2ec312a1"></a>
  419. <h2 class="memtitle"><span class="permalink"><a href="#a658c250984be29febf8f4d2a2ec312a1">&#9670;&nbsp;</a></span>rootDirectoryCluster()</h2>
  420. <div class="memitem">
  421. <div class="memproto">
  422. <table class="mlabels">
  423. <tr>
  424. <td class="mlabels-left">
  425. <table class="memname">
  426. <tr>
  427. <td class="memname">uint32_t ExFatPartition::rootDirectoryCluster </td>
  428. <td>(</td>
  429. <td class="paramname"></td><td>)</td>
  430. <td></td>
  431. </tr>
  432. </table>
  433. </td>
  434. <td class="mlabels-right">
  435. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <dl class="section return"><dt>Returns</dt><dd>the root directory start cluster number. </dd></dl>
  440. </div>
  441. </div>
  442. <a id="a9412bd687edc99266c88f8aa87f01c51"></a>
  443. <h2 class="memtitle"><span class="permalink"><a href="#a9412bd687edc99266c88f8aa87f01c51">&#9670;&nbsp;</a></span>rootLength()</h2>
  444. <div class="memitem">
  445. <div class="memproto">
  446. <table class="memname">
  447. <tr>
  448. <td class="memname">uint32_t ExFatPartition::rootLength </td>
  449. <td>(</td>
  450. <td class="paramname"></td><td>)</td>
  451. <td></td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. <dl class="section return"><dt>Returns</dt><dd>the root directory length. </dd></dl>
  456. </div>
  457. </div>
  458. <a id="aaa7306ac8ff29f50ec4d919ccaff10d7"></a>
  459. <h2 class="memtitle"><span class="permalink"><a href="#aaa7306ac8ff29f50ec4d919ccaff10d7">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="mlabels">
  463. <tr>
  464. <td class="mlabels-left">
  465. <table class="memname">
  466. <tr>
  467. <td class="memname">uint32_t ExFatPartition::sectorsPerCluster </td>
  468. <td>(</td>
  469. <td class="paramname"></td><td>)</td>
  470. <td></td>
  471. </tr>
  472. </table>
  473. </td>
  474. <td class="mlabels-right">
  475. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  476. </tr>
  477. </table>
  478. </div><div class="memdoc">
  479. <dl class="section return"><dt>Returns</dt><dd>the number of sectors in a cluster. </dd></dl>
  480. </div>
  481. </div>
  482. <a id="ab1624bf02690ee06365207cb8f1d48ac"></a>
  483. <h2 class="memtitle"><span class="permalink"><a href="#ab1624bf02690ee06365207cb8f1d48ac">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>
  484. <div class="memitem">
  485. <div class="memproto">
  486. <table class="mlabels">
  487. <tr>
  488. <td class="mlabels-left">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname">uint8_t ExFatPartition::sectorsPerClusterShift </td>
  492. <td>(</td>
  493. <td class="paramname"></td><td>)</td>
  494. <td></td>
  495. </tr>
  496. </table>
  497. </td>
  498. <td class="mlabels-right">
  499. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  500. </tr>
  501. </table>
  502. </div><div class="memdoc">
  503. <dl class="section return"><dt>Returns</dt><dd>the power of two for sectors per cluster. </dd></dl>
  504. </div>
  505. </div>
  506. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  507. <a id="a0ea68fb710b4ca007419acbf84ca6908"></a>
  508. <h2 class="memtitle"><span class="permalink"><a href="#a0ea68fb710b4ca007419acbf84ca6908">&#9670;&nbsp;</a></span>ExFatFile</h2>
  509. <div class="memitem">
  510. <div class="memproto">
  511. <table class="mlabels">
  512. <tr>
  513. <td class="mlabels-left">
  514. <table class="memname">
  515. <tr>
  516. <td class="memname">friend class <a class="el" href="class_ex_fat_file.html">ExFatFile</a></td>
  517. </tr>
  518. </table>
  519. </td>
  520. <td class="mlabels-right">
  521. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  522. </tr>
  523. </table>
  524. </div><div class="memdoc">
  525. <p><a class="el" href="class_ex_fat_file.html" title="Basic file class.">ExFatFile</a> allowed access to private members. </p>
  526. </div>
  527. </div>
  528. <hr/>The documentation for this class was generated from the following files:<ul>
  529. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_partition_8h.html">ExFatPartition.h</a></li>
  530. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatPartition.cpp</li>
  531. </ul>
  532. </div><!-- contents -->
  533. <!-- start footer part -->
  534. <hr class="footer"/><address class="footer"><small>
  535. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  536. <img class="footer" src="doxygen.png" alt="doxygen"/>
  537. </a> 1.8.16
  538. </small></address>
  539. </body>
  540. </html>