visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/class_ex_fat_partition.html

579 lines
25KB
Raw Permalink Blame History 

  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. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="#friends">Friends</a> &#124;

  67. <a href="class_ex_fat_partition-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">ExFatPartition Class Reference</div>  </div>

  70. </div><!--header-->

  71. <div class="contents">

  72. 

  73. <p>Access exFat partitions on raw file devices.  

  74.  <a href="class_ex_fat_partition.html#details">More...</a></p>

  75. 

  76. <p><code>#include &lt;ExFatPartition.h&gt;</code></p>

  77. <div class="dynheader">

  78. Inheritance diagram for ExFatPartition:</div>

  79. <div class="dyncontent">

  80. <div class="center"><img src="class_ex_fat_partition__inherit__graph.png" border="0" usemap="#_ex_fat_partition_inherit__map" alt="Inheritance graph"/></div>

  81. <map name="_ex_fat_partition_inherit__map" id="_ex_fat_partition_inherit__map">

  82. <area shape="rect" title="Access exFat partitions on raw file devices." alt="" coords="38,5,143,32"/>

  83. <area shape="rect" href="class_ex_fat_volume.html" title="exFAT volume." alt="" coords="40,80,141,107"/>

  84. <area shape="rect" href="class_sd_base.html" title=" " alt="" coords="5,155,176,181"/>

  85. <area shape="rect" href="class_sd_ex_fat.html" title="SD file system class for exFAT volumes." alt="" coords="54,229,127,256"/>

  86. </map>

  87. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  88. <table class="memberdecls">

  89. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  90. Public Member Functions</h2></td></tr>

  91. <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>

  92. <tr class="separator:a1da789000f42592f9509df843fdd50c8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <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>

  94. <tr class="separator:a64825a52f754bdcb02c8632f5fd15373"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <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>

  96. <tr class="separator:adea3221412eb4bf5c19b6311573135f8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <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>

  98. <tr class="separator:a715f3574452c27ecf51b66208ce5e4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. <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>

  100. <tr class="separator:a63fac808e421ed5c8e72a37616ac56ac"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <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>

  102. <tr class="separator:ac01eb583924286617b0ee8fcf7409ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <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>

  104. <tr class="separator:a58b96587b787f4164eb719913dfbaaf5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. <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>

  106. <tr class="separator:aa7d1ae15168896ccc2648b4c383b34eb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <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>

  108. <tr class="separator:a9eff9e65b511ec06b62856bff8ed29eb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  109. <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>

  110. <tr class="separator:a3e63d87b4ef985f92c1793d269274f44"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <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>

  112. <tr class="separator:ae6d4414d6440b79b6314cd1edbaa35b0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. <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>

  114. <tr class="separator:adb1d277492dccba09031e2064f4fa66f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  115. <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>

  116. <tr class="separator:a658c250984be29febf8f4d2a2ec312a1"><td class="memSeparator" colspan="2">&#160;</td></tr>

  117. <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>

  118. <tr class="separator:a9412bd687edc99266c88f8aa87f01c51"><td class="memSeparator" colspan="2">&#160;</td></tr>

  119. <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>

  120. <tr class="separator:aaa7306ac8ff29f50ec4d919ccaff10d7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  121. <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>

  122. <tr class="separator:ab1624bf02690ee06365207cb8f1d48ac"><td class="memSeparator" colspan="2">&#160;</td></tr>

  123. </table><table class="memberdecls">

  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  125. Friends</h2></td></tr>

  126. <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>

  127. <tr class="separator:a0ea68fb710b4ca007419acbf84ca6908"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. </table>

  129. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  130. <div class="textblock"><p>Access exFat partitions on raw file devices. </p>

  131. </div><h2 class="groupheader">Member Function Documentation</h2>

  132. <a id="a1da789000f42592f9509df843fdd50c8"></a>

  133. <h2 class="memtitle"><span class="permalink"><a href="#a1da789000f42592f9509df843fdd50c8">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>

  134. 

  135. <div class="memitem">

  136. <div class="memproto">

  137. <table class="mlabels">

  138.   <tr>

  139.   <td class="mlabels-left">

  140.       <table class="memname">

  141.         <tr>

  142.           <td class="memname">uint32_t ExFatPartition::bytesPerCluster </td>

  143.           <td>(</td>

  144.           <td class="paramname"></td><td>)</td>

  145.           <td></td>

  146.         </tr>

  147.       </table>

  148.   </td>

  149.   <td class="mlabels-right">

  150. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  151.   </tr>

  152. </table>

  153. </div><div class="memdoc">

  154. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a cluster. </dd></dl>

  155. 

  156. </div>

  157. </div>

  158. <a id="a64825a52f754bdcb02c8632f5fd15373"></a>

  159. <h2 class="memtitle"><span class="permalink"><a href="#a64825a52f754bdcb02c8632f5fd15373">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>

  160. 

  161. <div class="memitem">

  162. <div class="memproto">

  163. <table class="mlabels">

  164.   <tr>

  165.   <td class="mlabels-left">

  166.       <table class="memname">

  167.         <tr>

  168.           <td class="memname">uint8_t ExFatPartition::bytesPerClusterShift </td>

  169.           <td>(</td>

  170.           <td class="paramname"></td><td>)</td>

  171.           <td></td>

  172.         </tr>

  173.       </table>

  174.   </td>

  175.   <td class="mlabels-right">

  176. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  177.   </tr>

  178. </table>

  179. </div><div class="memdoc">

  180. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerCluster. </dd></dl>

  181. 

  182. </div>

  183. </div>

  184. <a id="adea3221412eb4bf5c19b6311573135f8"></a>

  185. <h2 class="memtitle"><span class="permalink"><a href="#adea3221412eb4bf5c19b6311573135f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>

  186. 

  187. <div class="memitem">

  188. <div class="memproto">

  189. <table class="mlabels">

  190.   <tr>

  191.   <td class="mlabels-left">

  192.       <table class="memname">

  193.         <tr>

  194.           <td class="memname">uint16_t ExFatPartition::bytesPerSector </td>

  195.           <td>(</td>

  196.           <td class="paramname"></td><td>)</td>

  197.           <td></td>

  198.         </tr>

  199.       </table>

  200.   </td>

  201.   <td class="mlabels-right">

  202. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  203.   </tr>

  204. </table>

  205. </div><div class="memdoc">

  206. <dl class="section return"><dt>Returns</dt><dd>the number of bytes in a sector. </dd></dl>

  207. 

  208. </div>

  209. </div>

  210. <a id="a715f3574452c27ecf51b66208ce5e4a7"></a>

  211. <h2 class="memtitle"><span class="permalink"><a href="#a715f3574452c27ecf51b66208ce5e4a7">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>

  212. 

  213. <div class="memitem">

  214. <div class="memproto">

  215. <table class="mlabels">

  216.   <tr>

  217.   <td class="mlabels-left">

  218.       <table class="memname">

  219.         <tr>

  220.           <td class="memname">uint8_t ExFatPartition::bytesPerSectorShift </td>

  221.           <td>(</td>

  222.           <td class="paramname"></td><td>)</td>

  223.           <td></td>

  224.         </tr>

  225.       </table>

  226.   </td>

  227.   <td class="mlabels-right">

  228. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  229.   </tr>

  230. </table>

  231. </div><div class="memdoc">

  232. <dl class="section return"><dt>Returns</dt><dd>the power of two for bytesPerSector. </dd></dl>

  233. 

  234. </div>

  235. </div>

  236. <a id="a63fac808e421ed5c8e72a37616ac56ac"></a>

  237. <h2 class="memtitle"><span class="permalink"><a href="#a63fac808e421ed5c8e72a37616ac56ac">&#9670;&nbsp;</a></span>cacheClear()</h2>

  238. 

  239. <div class="memitem">

  240. <div class="memproto">

  241. <table class="mlabels">

  242.   <tr>

  243.   <td class="mlabels-left">

  244.       <table class="memname">

  245.         <tr>

  246.           <td class="memname">uint8_t* ExFatPartition::cacheClear </td>

  247.           <td>(</td>

  248.           <td class="paramname"></td><td>)</td>

  249.           <td></td>

  250.         </tr>

  251.       </table>

  252.   </td>

  253.   <td class="mlabels-right">

  254. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  255.   </tr>

  256. </table>

  257. </div><div class="memdoc">

  258. <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>

  259. 

  260. </div>

  261. </div>

  262. <a id="ac01eb583924286617b0ee8fcf7409ac0"></a>

  263. <h2 class="memtitle"><span class="permalink"><a href="#ac01eb583924286617b0ee8fcf7409ac0">&#9670;&nbsp;</a></span>clusterCount()</h2>

  264. 

  265. <div class="memitem">

  266. <div class="memproto">

  267. <table class="mlabels">

  268.   <tr>

  269.   <td class="mlabels-left">

  270.       <table class="memname">

  271.         <tr>

  272.           <td class="memname">uint32_t ExFatPartition::clusterCount </td>

  273.           <td>(</td>

  274.           <td class="paramname"></td><td>)</td>

  275.           <td></td>

  276.         </tr>

  277.       </table>

  278.   </td>

  279.   <td class="mlabels-right">

  280. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  281.   </tr>

  282. </table>

  283. </div><div class="memdoc">

  284. <dl class="section return"><dt>Returns</dt><dd>the cluster count for the partition. </dd></dl>

  285. 

  286. </div>

  287. </div>

  288. <a id="a58b96587b787f4164eb719913dfbaaf5"></a>

  289. <h2 class="memtitle"><span class="permalink"><a href="#a58b96587b787f4164eb719913dfbaaf5">&#9670;&nbsp;</a></span>clusterHeapStartSector()</h2>

  290. 

  291. <div class="memitem">

  292. <div class="memproto">

  293. <table class="mlabels">

  294.   <tr>

  295.   <td class="mlabels-left">

  296.       <table class="memname">

  297.         <tr>

  298.           <td class="memname">uint32_t ExFatPartition::clusterHeapStartSector </td>

  299.           <td>(</td>

  300.           <td class="paramname"></td><td>)</td>

  301.           <td></td>

  302.         </tr>

  303.       </table>

  304.   </td>

  305.   <td class="mlabels-right">

  306. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  307.   </tr>

  308. </table>

  309. </div><div class="memdoc">

  310. <dl class="section return"><dt>Returns</dt><dd>the cluster heap start sector. </dd></dl>

  311. 

  312. </div>

  313. </div>

  314. <a id="aa7d1ae15168896ccc2648b4c383b34eb"></a>

  315. <h2 class="memtitle"><span class="permalink"><a href="#aa7d1ae15168896ccc2648b4c383b34eb">&#9670;&nbsp;</a></span>fatLength()</h2>

  316. 

  317. <div class="memitem">

  318. <div class="memproto">

  319. <table class="mlabels">

  320.   <tr>

  321.   <td class="mlabels-left">

  322.       <table class="memname">

  323.         <tr>

  324.           <td class="memname">uint32_t ExFatPartition::fatLength </td>

  325.           <td>(</td>

  326.           <td class="paramname"></td><td>)</td>

  327.           <td></td>

  328.         </tr>

  329.       </table>

  330.   </td>

  331.   <td class="mlabels-right">

  332. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  333.   </tr>

  334. </table>

  335. </div><div class="memdoc">

  336. <dl class="section return"><dt>Returns</dt><dd>the FAT length in sectors </dd></dl>

  337. 

  338. </div>

  339. </div>

  340. <a id="a9eff9e65b511ec06b62856bff8ed29eb"></a>

  341. <h2 class="memtitle"><span class="permalink"><a href="#a9eff9e65b511ec06b62856bff8ed29eb">&#9670;&nbsp;</a></span>fatStartSector()</h2>

  342. 

  343. <div class="memitem">

  344. <div class="memproto">

  345. <table class="mlabels">

  346.   <tr>

  347.   <td class="mlabels-left">

  348.       <table class="memname">

  349.         <tr>

  350.           <td class="memname">uint32_t ExFatPartition::fatStartSector </td>

  351.           <td>(</td>

  352.           <td class="paramname"></td><td>)</td>

  353.           <td></td>

  354.         </tr>

  355.       </table>

  356.   </td>

  357.   <td class="mlabels-right">

  358. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  359.   </tr>

  360. </table>

  361. </div><div class="memdoc">

  362. <dl class="section return"><dt>Returns</dt><dd>the FAT start sector number. </dd></dl>

  363. 

  364. </div>

  365. </div>

  366. <a id="a3e63d87b4ef985f92c1793d269274f44"></a>

  367. <h2 class="memtitle"><span class="permalink"><a href="#a3e63d87b4ef985f92c1793d269274f44">&#9670;&nbsp;</a></span>fatType()</h2>

  368. 

  369. <div class="memitem">

  370. <div class="memproto">

  371. <table class="mlabels">

  372.   <tr>

  373.   <td class="mlabels-left">

  374.       <table class="memname">

  375.         <tr>

  376.           <td class="memname">uint8_t ExFatPartition::fatType </td>

  377.           <td>(</td>

  378.           <td class="paramname"></td><td>)</td>

  379.           <td> const</td>

  380.         </tr>

  381.       </table>

  382.   </td>

  383.   <td class="mlabels-right">

  384. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  385.   </tr>

  386. </table>

  387. </div><div class="memdoc">

  388. <dl class="section return"><dt>Returns</dt><dd>Type FAT_TYPE_EXFAT for exFAT partition or zero for error. </dd></dl>

  389. 

  390. </div>

  391. </div>

  392. <a id="ae6d4414d6440b79b6314cd1edbaa35b0"></a>

  393. <h2 class="memtitle"><span class="permalink"><a href="#ae6d4414d6440b79b6314cd1edbaa35b0">&#9670;&nbsp;</a></span>freeClusterCount()</h2>

  394. 

  395. <div class="memitem">

  396. <div class="memproto">

  397.       <table class="memname">

  398.         <tr>

  399.           <td class="memname">uint32_t ExFatPartition::freeClusterCount </td>

  400.           <td>(</td>

  401.           <td class="paramname"></td><td>)</td>

  402.           <td></td>

  403.         </tr>

  404.       </table>

  405. </div><div class="memdoc">

  406. <dl class="section return"><dt>Returns</dt><dd>the free cluster count. </dd></dl>

  407. 

  408. </div>

  409. </div>

  410. <a id="adb1d277492dccba09031e2064f4fa66f"></a>

  411. <h2 class="memtitle"><span class="permalink"><a href="#adb1d277492dccba09031e2064f4fa66f">&#9670;&nbsp;</a></span>init()</h2>

  412. 

  413. <div class="memitem">

  414. <div class="memproto">

  415.       <table class="memname">

  416.         <tr>

  417.           <td class="memname">bool ExFatPartition::init </td>

  418.           <td>(</td>

  419.           <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>

  420.           <td class="paramname"><em>dev</em>, </td>

  421.         </tr>

  422.         <tr>

  423.           <td class="paramkey"></td>

  424.           <td></td>

  425.           <td class="paramtype">uint8_t&#160;</td>

  426.           <td class="paramname"><em>part</em>&#160;</td>

  427.         </tr>

  428.         <tr>

  429.           <td></td>

  430.           <td>)</td>

  431.           <td></td><td></td>

  432.         </tr>

  433.       </table>

  434. </div><div class="memdoc">

  435. <p>Initialize a exFAT partition. </p><dl class="params"><dt>Parameters</dt><dd>

  436.   <table class="params">

  437.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The blockDevice for the partition. </td></tr>

  438.     <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>

  439.   </table>

  440.   </dd>

  441. </dl>

  442. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  443. 

  444. </div>

  445. </div>

  446. <a id="a658c250984be29febf8f4d2a2ec312a1"></a>

  447. <h2 class="memtitle"><span class="permalink"><a href="#a658c250984be29febf8f4d2a2ec312a1">&#9670;&nbsp;</a></span>rootDirectoryCluster()</h2>

  448. 

  449. <div class="memitem">

  450. <div class="memproto">

  451. <table class="mlabels">

  452.   <tr>

  453.   <td class="mlabels-left">

  454.       <table class="memname">

  455.         <tr>

  456.           <td class="memname">uint32_t ExFatPartition::rootDirectoryCluster </td>

  457.           <td>(</td>

  458.           <td class="paramname"></td><td>)</td>

  459.           <td></td>

  460.         </tr>

  461.       </table>

  462.   </td>

  463.   <td class="mlabels-right">

  464. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  465.   </tr>

  466. </table>

  467. </div><div class="memdoc">

  468. <dl class="section return"><dt>Returns</dt><dd>the root directory start cluster number. </dd></dl>

  469. 

  470. </div>

  471. </div>

  472. <a id="a9412bd687edc99266c88f8aa87f01c51"></a>

  473. <h2 class="memtitle"><span class="permalink"><a href="#a9412bd687edc99266c88f8aa87f01c51">&#9670;&nbsp;</a></span>rootLength()</h2>

  474. 

  475. <div class="memitem">

  476. <div class="memproto">

  477.       <table class="memname">

  478.         <tr>

  479.           <td class="memname">uint32_t ExFatPartition::rootLength </td>

  480.           <td>(</td>

  481.           <td class="paramname"></td><td>)</td>

  482.           <td></td>

  483.         </tr>

  484.       </table>

  485. </div><div class="memdoc">

  486. <dl class="section return"><dt>Returns</dt><dd>the root directory length. </dd></dl>

  487. 

  488. </div>

  489. </div>

  490. <a id="aaa7306ac8ff29f50ec4d919ccaff10d7"></a>

  491. <h2 class="memtitle"><span class="permalink"><a href="#aaa7306ac8ff29f50ec4d919ccaff10d7">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>

  492. 

  493. <div class="memitem">

  494. <div class="memproto">

  495. <table class="mlabels">

  496.   <tr>

  497.   <td class="mlabels-left">

  498.       <table class="memname">

  499.         <tr>

  500.           <td class="memname">uint32_t ExFatPartition::sectorsPerCluster </td>

  501.           <td>(</td>

  502.           <td class="paramname"></td><td>)</td>

  503.           <td></td>

  504.         </tr>

  505.       </table>

  506.   </td>

  507.   <td class="mlabels-right">

  508. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  509.   </tr>

  510. </table>

  511. </div><div class="memdoc">

  512. <dl class="section return"><dt>Returns</dt><dd>the number of sectors in a cluster. </dd></dl>

  513. 

  514. </div>

  515. </div>

  516. <a id="ab1624bf02690ee06365207cb8f1d48ac"></a>

  517. <h2 class="memtitle"><span class="permalink"><a href="#ab1624bf02690ee06365207cb8f1d48ac">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>

  518. 

  519. <div class="memitem">

  520. <div class="memproto">

  521. <table class="mlabels">

  522.   <tr>

  523.   <td class="mlabels-left">

  524.       <table class="memname">

  525.         <tr>

  526.           <td class="memname">uint8_t ExFatPartition::sectorsPerClusterShift </td>

  527.           <td>(</td>

  528.           <td class="paramname"></td><td>)</td>

  529.           <td></td>

  530.         </tr>

  531.       </table>

  532.   </td>

  533.   <td class="mlabels-right">

  534. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  535.   </tr>

  536. </table>

  537. </div><div class="memdoc">

  538. <dl class="section return"><dt>Returns</dt><dd>the power of two for sectors per cluster. </dd></dl>

  539. 

  540. </div>

  541. </div>

  542. <h2 class="groupheader">Friends And Related Function Documentation</h2>

  543. <a id="a0ea68fb710b4ca007419acbf84ca6908"></a>

  544. <h2 class="memtitle"><span class="permalink"><a href="#a0ea68fb710b4ca007419acbf84ca6908">&#9670;&nbsp;</a></span>ExFatFile</h2>

  545. 

  546. <div class="memitem">

  547. <div class="memproto">

  548. <table class="mlabels">

  549.   <tr>

  550.   <td class="mlabels-left">

  551.       <table class="memname">

  552.         <tr>

  553.           <td class="memname">friend class <a class="el" href="class_ex_fat_file.html">ExFatFile</a></td>

  554.         </tr>

  555.       </table>

  556.   </td>

  557.   <td class="mlabels-right">

  558. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  559.   </tr>

  560. </table>

  561. </div><div class="memdoc">

  562. <p><a class="el" href="class_ex_fat_file.html" title="Basic file class.">ExFatFile</a> allowed access to private members. </p>

  563. 

  564. </div>

  565. </div>

  566. <hr/>The documentation for this class was generated from the following files:<ul>

  567. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/<a class="el" href="_ex_fat_partition_8h.html">ExFatPartition.h</a></li>

  568. <li>ArduinoSdFat/libraries/SdFat/src/ExFatLib/ExFatPartition.cpp</li>

  569. </ul>

  570. </div><!-- contents -->

  571. <!-- start footer part -->

  572. <hr class="footer"/><address class="footer"><small>

  573. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  574. <img class="footer" src="doxygen.png" alt="doxygen"/>

  575. </a> 1.8.16

  576. </small></address>

  577. </body>

  578. </html>