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.
5 Commits
1 Branch
Tree: 60d32214a3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '60d32214a3'
${ noResults }
teensy-sdfat/html/class_sd_volume.html

581 lines
25KB
Raw Blame History 

  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.6"/>

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

  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><a href="namespaces.html"><span>Namespaces</span></a></li>

  33.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  34.       <li><a href="files.html"><span>Files</span></a></li>

  35.     </ul>

  36.   </div>

  37.   <div id="navrow2" class="tabs2">

  38.     <ul class="tablist">

  39.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  40.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  41.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  42.     </ul>

  43.   </div>

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

  45. <div class="header">

  46.   <div class="summary">

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

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

  49. <a href="class_sd_volume-members.html">List of all members</a>  </div>

  50.   <div class="headertitle">

  51. <div class="title">SdVolume Class Reference</div>  </div>

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

  53. <div class="contents">

  54. 

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

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

  57. 

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

  59. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  99. <tr class="memitem:a05e466c179d34fec11c4406677fe0533"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a05e466c179d34fec11c4406677fe0533">SdBaseFile</a></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>

  199. <dl class="section return"><dt>Returns</dt><dd>A pointer to the cache buffer or zero if an error occurs. </dd></dl>

  200. 

  201. </div>

  202. </div>

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

  204. <div class="memitem">

  205. <div class="memproto">

  206. <table class="mlabels">

  207.   <tr>

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

  209.       <table class="memname">

  210.         <tr>

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

  212.           <td>(</td>

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

  214.           <td> const</td>

  215.         </tr>

  216.       </table>

  217.   </td>

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

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

  220.   </tr>

  221. </table>

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

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

  224. 

  225. </div>

  226. </div>

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

  228. <div class="memitem">

  229. <div class="memproto">

  230. <table class="mlabels">

  231.   <tr>

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

  233.       <table class="memname">

  234.         <tr>

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

  236.           <td>(</td>

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

  238.           <td> const</td>

  239.         </tr>

  240.       </table>

  241.   </td>

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

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

  244.   </tr>

  245. </table>

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

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

  248. 

  249. </div>

  250. </div>

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

  252. <div class="memitem">

  253. <div class="memproto">

  254. <table class="mlabels">

  255.   <tr>

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

  257.       <table class="memname">

  258.         <tr>

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

  260.           <td>(</td>

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

  262.           <td> const</td>

  263.         </tr>

  264.       </table>

  265.   </td>

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

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

  268.   </tr>

  269. </table>

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

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

  272. 

  273. </div>

  274. </div>

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

  276. <div class="memitem">

  277. <div class="memproto">

  278. <table class="mlabels">

  279.   <tr>

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

  281.       <table class="memname">

  282.         <tr>

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

  284.           <td>(</td>

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

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

  287.         </tr>

  288.         <tr>

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

  290.           <td></td>

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

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

  293.         </tr>

  294.         <tr>

  295.           <td></td>

  296.           <td>)</td>

  297.           <td></td><td></td>

  298.         </tr>

  299.       </table>

  300.   </td>

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

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

  303.   </tr>

  304. </table>

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

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

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

  308.   <table class="params">

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

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

  311.   </table>

  312.   </dd>

  313. </dl>

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

  315. 

  316. </div>

  317. </div>

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

  319. <div class="memitem">

  320. <div class="memproto">

  321. <table class="mlabels">

  322.   <tr>

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

  324.       <table class="memname">

  325.         <tr>

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

  327.           <td>(</td>

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

  329.           <td> const</td>

  330.         </tr>

  331.       </table>

  332.   </td>

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

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

  335.   </tr>

  336. </table>

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

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

  339. 

  340. </div>

  341. </div>

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

  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 SdVolume::fatStartBlock </td>

  351.           <td>(</td>

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

  353.           <td> const</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 logical block number for the start of the first FAT. </dd></dl>

  363. 

  364. </div>

  365. </div>

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

  367. <div class="memitem">

  368. <div class="memproto">

  369. <table class="mlabels">

  370.   <tr>

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

  372.       <table class="memname">

  373.         <tr>

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

  375.           <td>(</td>

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

  377.           <td> const</td>

  378.         </tr>

  379.       </table>

  380.   </td>

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

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

  383.   </tr>

  384. </table>

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

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

  387. 

  388. </div>

  389. </div>

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

  391. <div class="memitem">

  392. <div class="memproto">

  393.       <table class="memname">

  394.         <tr>

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

  396.           <td>(</td>

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

  398.           <td></td>

  399.         </tr>

  400.       </table>

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

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

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

  404. 

  405. </div>

  406. </div>

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

  408. <div class="memitem">

  409. <div class="memproto">

  410. <table class="mlabels">

  411.   <tr>

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

  413.       <table class="memname">

  414.         <tr>

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

  416.           <td>(</td>

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

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

  419.           <td></td>

  420.         </tr>

  421.       </table>

  422.   </td>

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

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

  425.   </tr>

  426. </table>

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

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

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

  430.   <table class="params">

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

  432.   </table>

  433.   </dd>

  434. </dl>

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

  436. 

  437. </div>

  438. </div>

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

  440. <div class="memitem">

  441. <div class="memproto">

  442.       <table class="memname">

  443.         <tr>

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

  445.           <td>(</td>

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

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

  448.         </tr>

  449.         <tr>

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

  451.           <td></td>

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

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

  454.         </tr>

  455.         <tr>

  456.           <td></td>

  457.           <td>)</td>

  458.           <td></td><td></td>

  459.         </tr>

  460.       </table>

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

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

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

  464.   <table class="params">

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

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

  467.   </table>

  468.   </dd>

  469. </dl>

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

  471. 

  472. </div>

  473. </div>

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

  475. <div class="memitem">

  476. <div class="memproto">

  477. <table class="mlabels">

  478.   <tr>

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

  480.       <table class="memname">

  481.         <tr>

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

  483.           <td>(</td>

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

  485.           <td> const</td>

  486.         </tr>

  487.       </table>

  488.   </td>

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

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

  491.   </tr>

  492. </table>

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

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

  495. 

  496. </div>

  497. </div>

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

  499. <div class="memitem">

  500. <div class="memproto">

  501. <table class="mlabels">

  502.   <tr>

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

  504.       <table class="memname">

  505.         <tr>

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

  507.           <td>(</td>

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

  509.           <td> const</td>

  510.         </tr>

  511.       </table>

  512.   </td>

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

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

  515.   </tr>

  516. </table>

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

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

  519. 

  520. </div>

  521. </div>

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

  523. <div class="memitem">

  524. <div class="memproto">

  525. <table class="mlabels">

  526.   <tr>

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

  528.       <table class="memname">

  529.         <tr>

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

  531.           <td>(</td>

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

  533.           <td></td>

  534.         </tr>

  535.       </table>

  536.   </td>

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

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

  539.   </tr>

  540. </table>

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

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

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

  544. 

  545. </div>

  546. </div>

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

  548. <a class="anchor" id="a05e466c179d34fec11c4406677fe0533"></a>

  549. <div class="memitem">

  550. <div class="memproto">

  551. <table class="mlabels">

  552.   <tr>

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

  554.       <table class="memname">

  555.         <tr>

  556.           <td class="memname">friend class <a class="el" href="class_sd_base_file.html">SdBaseFile</a></td>

  557.         </tr>

  558.       </table>

  559.   </td>

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

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

  562.   </tr>

  563. </table>

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

  565. 

  566. </div>

  567. </div>

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

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

  570. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_volume_8cpp.html">SdVolume.cpp</a></li>

  571. </ul>

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

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

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

  575. Generated on Fri Sep 5 2014 13:07:46 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  577. </a> 1.8.6

  578. </small></address>

  579. </body>

  580. </html>