visus
/
teensy-sdfat
關註 1
收藏 0
複製 0
程式碼 問題管理 0 合併請求 0 版本發佈 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.
9 Commit
1 分支
目錄樹: 940b09a7dd
分支列表 標籤列表
${ item.name }
Create branch ${ searchTerm }
from '940b09a7dd'
${ noResults }
teensy-sdfat/html/class_sd_volume.html

558 line
24KB
原始文件 Blame 文件歷史 

  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. 

  54. <p>Access FAT16 and FAT32 volumes on SD and SDHC cards.  

  55.  <a href="class_sd_volume.html#details">More...</a></p>

  56. 

  57. <p><code>#include &lt;SdVolume.h&gt;</code></p>

  58. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  98. <tr class="memitem:a05e466c179d34fec11c4406677fe0533"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05e466c179d34fec11c4406677fe0533"></a>

  99. class&#160;</td><td class="memItemRight" valign="bottom"><b>SdBaseFile</b></td></tr>

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

  101. </table>

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

  103. <div class="textblock"><p>Access FAT16 and FAT32 volumes on SD and SDHC cards. </p>

  104. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  105. <a class="anchor" id="a30d4489087fbdce20b8fe1a624dbe658"></a>

  106. <div class="memitem">

  107. <div class="memproto">

  108. <table class="mlabels">

  109.   <tr>

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

  111.       <table class="memname">

  112.         <tr>

  113.           <td class="memname">SdVolume::SdVolume </td>

  114.           <td>(</td>

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

  116.           <td></td>

  117.         </tr>

  118.       </table>

  119.   </td>

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

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

  122.   </tr>

  123. </table>

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

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

  126. 

  127. </div>

  128. </div>

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

  130. <a class="anchor" id="affab4c57c98e41ee55b21c87f814804b"></a>

  131. <div class="memitem">

  132. <div class="memproto">

  133. <table class="mlabels">

  134.   <tr>

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

  136.       <table class="memname">

  137.         <tr>

  138.           <td class="memname">uint8_t SdVolume::blocksPerCluster </td>

  139.           <td>(</td>

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

  141.           <td> const</td>

  142.         </tr>

  143.       </table>

  144.   </td>

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

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

  147.   </tr>

  148. </table>

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

  150. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>

  151. 

  152. </div>

  153. </div>

  154. <a class="anchor" id="a87ed6542db9642ffa106def897a368c6"></a>

  155. <div class="memitem">

  156. <div class="memproto">

  157. <table class="mlabels">

  158.   <tr>

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

  160.       <table class="memname">

  161.         <tr>

  162.           <td class="memname">uint32_t SdVolume::blocksPerFat </td>

  163.           <td>(</td>

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

  165.           <td> const</td>

  166.         </tr>

  167.       </table>

  168.   </td>

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

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

  171.   </tr>

  172. </table>

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

  174. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>

  175. 

  176. </div>

  177. </div>

  178. <a class="anchor" id="adaecef65fdf94d323597a461eb641f5e"></a>

  179. <div class="memitem">

  180. <div class="memproto">

  181. <table class="mlabels">

  182.   <tr>

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

  184.       <table class="memname">

  185.         <tr>

  186.           <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* SdVolume::cacheClear </td>

  187.           <td>(</td>

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

  189.           <td></td>

  190.         </tr>

  191.       </table>

  192.   </td>

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

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

  195.   </tr>

  196. </table>

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

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

  199. 

  200. </div>

  201. </div>

  202. <a class="anchor" id="a323adfb5ac395b769f30c31ce2618f22"></a>

  203. <div class="memitem">

  204. <div class="memproto">

  205. <table class="mlabels">

  206.   <tr>

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

  208.       <table class="memname">

  209.         <tr>

  210.           <td class="memname">uint32_t SdVolume::clusterCount </td>

  211.           <td>(</td>

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

  213.           <td> const</td>

  214.         </tr>

  215.       </table>

  216.   </td>

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

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

  219.   </tr>

  220. </table>

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

  222. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>

  223. 

  224. </div>

  225. </div>

  226. <a class="anchor" id="a50c8e198feb63b0ca26737f91bd3e139"></a>

  227. <div class="memitem">

  228. <div class="memproto">

  229. <table class="mlabels">

  230.   <tr>

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

  232.       <table class="memname">

  233.         <tr>

  234.           <td class="memname">uint8_t SdVolume::clusterSizeShift </td>

  235.           <td>(</td>

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

  237.           <td> const</td>

  238.         </tr>

  239.       </table>

  240.   </td>

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

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

  243.   </tr>

  244. </table>

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

  246. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>

  247. 

  248. </div>

  249. </div>

  250. <a class="anchor" id="a99ca71035785948c42ade0863f91c9ab"></a>

  251. <div class="memitem">

  252. <div class="memproto">

  253. <table class="mlabels">

  254.   <tr>

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

  256.       <table class="memname">

  257.         <tr>

  258.           <td class="memname">uint32_t SdVolume::dataStartBlock </td>

  259.           <td>(</td>

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

  261.           <td> const</td>

  262.         </tr>

  263.       </table>

  264.   </td>

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

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

  267.   </tr>

  268. </table>

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

  270. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>

  271. 

  272. </div>

  273. </div>

  274. <a class="anchor" id="a4dbcb7b34a83468b1c6f8c4556393526"></a>

  275. <div class="memitem">

  276. <div class="memproto">

  277. <table class="mlabels">

  278.   <tr>

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

  280.       <table class="memname">

  281.         <tr>

  282.           <td class="memname">bool SdVolume::dbgFat </td>

  283.           <td>(</td>

  284.           <td class="paramtype">uint32_t&#160;</td>

  285.           <td class="paramname"><em>n</em>, </td>

  286.         </tr>

  287.         <tr>

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

  289.           <td></td>

  290.           <td class="paramtype">uint32_t *&#160;</td>

  291.           <td class="paramname"><em>v</em>&#160;</td>

  292.         </tr>

  293.         <tr>

  294.           <td></td>

  295.           <td>)</td>

  296.           <td></td><td></td>

  297.         </tr>

  298.       </table>

  299.   </td>

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

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

  302.   </tr>

  303. </table>

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

  305. <p>Debug access to FAT table</p>

  306. <dl class="params"><dt>Parameters</dt><dd>

  307.   <table class="params">

  308.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>

  309.     <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>

  310.   </table>

  311.   </dd>

  312. </dl>

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

  314. 

  315. </div>

  316. </div>

  317. <a class="anchor" id="a5d4307584ef14e4a2fef85b4954b1aa2"></a>

  318. <div class="memitem">

  319. <div class="memproto">

  320. <table class="mlabels">

  321.   <tr>

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

  323.       <table class="memname">

  324.         <tr>

  325.           <td class="memname">uint8_t SdVolume::fatCount </td>

  326.           <td>(</td>

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

  328.           <td> const</td>

  329.         </tr>

  330.       </table>

  331.   </td>

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

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

  334.   </tr>

  335. </table>

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

  337. <dl class="section return"><dt>Returns</dt><dd>The number of FAT structures on the volume. </dd></dl>

  338. 

  339. </div>

  340. </div>

  341. <a class="anchor" id="a9032ec5d3323ee67477c6bbf39821415"></a>

  342. <div class="memitem">

  343. <div class="memproto">

  344. <table class="mlabels">

  345.   <tr>

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

  347.       <table class="memname">

  348.         <tr>

  349.           <td class="memname">uint32_t SdVolume::fatStartBlock </td>

  350.           <td>(</td>

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

  352.           <td> const</td>

  353.         </tr>

  354.       </table>

  355.   </td>

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

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

  358.   </tr>

  359. </table>

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

  361. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>

  362. 

  363. </div>

  364. </div>

  365. <a class="anchor" id="a3f7b12db1e9ec4b847cd41fbe46b7baf"></a>

  366. <div class="memitem">

  367. <div class="memproto">

  368. <table class="mlabels">

  369.   <tr>

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

  371.       <table class="memname">

  372.         <tr>

  373.           <td class="memname">uint8_t SdVolume::fatType </td>

  374.           <td>(</td>

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

  376.           <td> const</td>

  377.         </tr>

  378.       </table>

  379.   </td>

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

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

  382.   </tr>

  383. </table>

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

  385. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>

  386. 

  387. </div>

  388. </div>

  389. <a class="anchor" id="a162efe707ab46847202300cb38739629"></a>

  390. <div class="memitem">

  391. <div class="memproto">

  392.       <table class="memname">

  393.         <tr>

  394.           <td class="memname">int32_t SdVolume::freeClusterCount </td>

  395.           <td>(</td>

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

  397.           <td></td>

  398.         </tr>

  399.       </table>

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

  401. <p>Volume free space in clusters.</p>

  402. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>

  403. 

  404. </div>

  405. </div>

  406. <a class="anchor" id="a0ac221eda119ddccae8ac6bc20a4b12d"></a>

  407. <div class="memitem">

  408. <div class="memproto">

  409. <table class="mlabels">

  410.   <tr>

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

  412.       <table class="memname">

  413.         <tr>

  414.           <td class="memname">bool SdVolume::init </td>

  415.           <td>(</td>

  416.           <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>

  417.           <td class="paramname"><em>dev</em></td><td>)</td>

  418.           <td></td>

  419.         </tr>

  420.       </table>

  421.   </td>

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

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

  424.   </tr>

  425. </table>

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

  427. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>

  428. <dl class="params"><dt>Parameters</dt><dd>

  429.   <table class="params">

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

  431.   </table>

  432.   </dd>

  433. </dl>

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

  435. 

  436. </div>

  437. </div>

  438. <a class="anchor" id="ae820ee8d9ea7ed01ce72ae3508a63cbf"></a>

  439. <div class="memitem">

  440. <div class="memproto">

  441.       <table class="memname">

  442.         <tr>

  443.           <td class="memname">bool SdVolume::init </td>

  444.           <td>(</td>

  445.           <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>

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

  447.         </tr>

  448.         <tr>

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

  450.           <td></td>

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

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

  453.         </tr>

  454.         <tr>

  455.           <td></td>

  456.           <td>)</td>

  457.           <td></td><td></td>

  458.         </tr>

  459.       </table>

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

  461. <p>Initialize a FAT volume.</p>

  462. <dl class="params"><dt>Parameters</dt><dd>

  463.   <table class="params">

  464.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The SD card where the volume is located.</td></tr>

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

  466.   </table>

  467.   </dd>

  468. </dl>

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

  470. 

  471. </div>

  472. </div>

  473. <a class="anchor" id="a8573884a8056ab7c4c0d6e442f676cc4"></a>

  474. <div class="memitem">

  475. <div class="memproto">

  476. <table class="mlabels">

  477.   <tr>

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

  479.       <table class="memname">

  480.         <tr>

  481.           <td class="memname">uint32_t SdVolume::rootDirEntryCount </td>

  482.           <td>(</td>

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

  484.           <td> const</td>

  485.         </tr>

  486.       </table>

  487.   </td>

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

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

  490.   </tr>

  491. </table>

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

  493. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>

  494. 

  495. </div>

  496. </div>

  497. <a class="anchor" id="aa1479f90c53bc9eac379664c5233d399"></a>

  498. <div class="memitem">

  499. <div class="memproto">

  500. <table class="mlabels">

  501.   <tr>

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

  503.       <table class="memname">

  504.         <tr>

  505.           <td class="memname">uint32_t SdVolume::rootDirStart </td>

  506.           <td>(</td>

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

  508.           <td> const</td>

  509.         </tr>

  510.       </table>

  511.   </td>

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

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

  514.   </tr>

  515. </table>

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

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

  518. 

  519. </div>

  520. </div>

  521. <a class="anchor" id="afe76a9f7c181458995518dc8530a1fad"></a>

  522. <div class="memitem">

  523. <div class="memproto">

  524. <table class="mlabels">

  525.   <tr>

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

  527.       <table class="memname">

  528.         <tr>

  529.           <td class="memname"><a class="el" href="class_sd2_card.html">Sd2Card</a>* SdVolume::sdCard </td>

  530.           <td>(</td>

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

  532.           <td></td>

  533.         </tr>

  534.       </table>

  535.   </td>

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

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

  538.   </tr>

  539. </table>

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

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

  542. 

  543. </div>

  544. </div>

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

  546. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_volume_8h.html">SdVolume.h</a></li>

  547. <li>Arduino/libraries/SdFat/SdVolume.cpp</li>

  548. </ul>

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

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

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

  552. Generated on Sat Oct 25 2014 07:56:23 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  554. </a> 1.8.8

  555. </small></address>

  556. </body>

  557. </html>