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/_sd_base_file_8h.html

283 line
16KB
原始文件 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: Arduino/libraries/SdFat/SdBaseFile.h File 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><a href="annotated.html"><span>Classes</span></a></li>

  33.       <li class="current"><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="files.html"><span>File&#160;List</span></a></li>

  39.       <li><a href="globals.html"><span>File&#160;Members</span></a></li>

  40.     </ul>

  41.   </div>

  42. <div id="nav-path" class="navpath">

  43.   <ul>

  44. <li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li><li class="navelem"><a class="el" href="dir_1281b15c327061056ab3b326e90c50cf.html">SdFat</a></li>  </ul>

  45. </div>

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

  47. <div class="header">

  48.   <div class="summary">

  49. <a href="#nested-classes">Classes</a> &#124;

  50. <a href="#define-members">Macros</a> &#124;

  51. <a href="#var-members">Variables</a>  </div>

  52.   <div class="headertitle">

  53. <div class="title">SdBaseFile.h File Reference</div>  </div>

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

  55. <div class="contents">

  56. 

  57. <p><a class="el" href="class_sd_base_file.html" title="Base class for SdFile with Print and C++ streams. ">SdBaseFile</a> class.  

  58. <a href="#details">More...</a></p>

  59. <div class="textblock"><code>#include &lt;Arduino.h&gt;</code><br />

  60. <code>#include &lt;<a class="el" href="_sd_fat_config_8h.html">SdFatConfig.h</a>&gt;</code><br />

  61. <code>#include &lt;<a class="el" href="_sd_volume_8h.html">SdVolume.h</a>&gt;</code><br />

  62. <code>#include &lt;utility/FatApiConstants.h&gt;</code><br />

  63. </div><div class="textblock"><div class="dynheader">

  64. Include dependency graph for SdBaseFile.h:</div>

  65. <div class="dyncontent">

  66. <div class="center"><img src="_sd_base_file_8h__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_sd_base_file_8h" alt=""/></div>

  67. <map name="_arduino_2libraries_2_sd_fat_2_sd_base_file_8h" id="_arduino_2libraries_2_sd_fat_2_sd_base_file_8h">

  68. <area shape="rect" id="node5" href="_sd_fat_config_8h.html" title="configuration definitions " alt="" coords="5,320,109,347"/>
<area shape="rect" id="node9" href="_sd_volume_8h.html" title="SdVolume class. " alt="" coords="153,96,247,123"/>
<area shape="rect" id="node12" href="_sd2_card_8h.html" title="Sd2Card class for V2 SD/SDHC cards. " alt="" coords="224,171,307,197"/>
<area shape="rect" id="node18" href="_sd_spi_8h.html" title="SdSpi class for V2 SD/SDHC cards. " alt="" coords="121,245,188,272"/>
</map>

  69. </div>

  70. </div><div class="textblock"><div class="dynheader">

  71. This graph shows which files directly or indirectly include this file:</div>

  72. <div class="dyncontent">

  73. <div class="center"><img src="_sd_base_file_8h__dep__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_sd_base_file_8hdep" alt=""/></div>

  74. <map name="_arduino_2libraries_2_sd_fat_2_sd_base_file_8hdep" id="_arduino_2libraries_2_sd_fat_2_sd_base_file_8hdep">

  75. <area shape="rect" id="node3" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="248,97,403,138"/>
<area shape="rect" id="node17" href="_stdio_stream_8h.html" title="StdioStream class. " alt="" coords="299,641,453,682"/>
<area shape="rect" id="node20" href="_sd_stream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="5,369,160,410"/>
<area shape="rect" id="node26" href="_sd_file_8h.html" title="SdFile class. " alt="" coords="299,278,453,319"/>
<area shape="rect" id="node5" href="istream_8h.html" title="istream class " alt="" coords="69,187,224,229"/>
<area shape="rect" id="node23" href="ostream_8h.html" title="ostream class " alt="" coords="248,187,403,229"/>
<area shape="rect" id="node7" href="iostream_8h.html" title="iostream class " alt="" coords="95,278,249,319"/>
<area shape="rect" id="node9" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="184,369,339,410"/>
<area shape="rect" id="node11" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="184,459,339,501"/>
<area shape="rect" id="node13" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="209,550,364,591"/>
<area shape="rect" id="node15" href="_sd_fat_util_8h.html" title="Useful utility functions. " alt="" coords="120,641,275,682"/>
</map>

  76. </div>

  77. </div><table class="memberdecls">

  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>

  79. Classes</h2></td></tr>

  80. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_fat_pos__t.html">FatPos_t</a></td></tr>

  81. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">internal type for istream do not use in user apps  <a href="struct_fat_pos__t.html#details">More...</a><br /></td></tr>

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

  83. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_base_file.html">SdBaseFile</a></td></tr>

  84. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for <a class="el" href="class_sd_file.html" title="SdBaseFile with Arduino Stream. ">SdFile</a> with Print and C++ streams.  <a href="class_sd_base_file.html#details">More...</a><br /></td></tr>

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

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

  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>

  88. Macros</h2></td></tr>

  89. <tr class="memitem:a963f816fc88a5d8479c285ed4c630229"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a963f816fc88a5d8479c285ed4c630229">PGM_P</a>&#160;&#160;&#160;const char*</td></tr>

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

  91. <tr class="memitem:a48c60b057902adf805797f183286728d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a48c60b057902adf805797f183286728d">pgm_read_byte</a>(addr)&#160;&#160;&#160;(*(const unsigned char*)(addr))</td></tr>

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

  93. <tr class="memitem:a910fb5f01313d339d3b835d45e1e5ad0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a910fb5f01313d339d3b835d45e1e5ad0">pgm_read_word</a>(addr)&#160;&#160;&#160;(*(const uint16_t*)(addr))</td></tr>

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

  95. <tr class="memitem:a75acaba9e781937468d0911423bc0c35"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a75acaba9e781937468d0911423bc0c35">PROGMEM</a>&#160;&#160;&#160;const</td></tr>

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

  97. <tr class="memitem:a9c00057fd19e916cc1aa0a5949336beb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a9c00057fd19e916cc1aa0a5949336beb">PSTR</a>(x)&#160;&#160;&#160;(x)</td></tr>

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

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

  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>

  101. Variables</h2></td></tr>

  102. <tr class="memitem:a4da8c96e256b06356321e81705494010"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a4da8c96e256b06356321e81705494010">FAT_FILE_TYPE_CLOSED</a> = 0</td></tr>

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

  104. <tr class="memitem:abc9b0906aeeedfe122b0ca629bac889b"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#abc9b0906aeeedfe122b0ca629bac889b">FAT_FILE_TYPE_MIN_DIR</a> = <a class="el" href="_sd_base_file_8h.html#a1bb2e8f6b6f90bbf4d02608cd267af42">FAT_FILE_TYPE_ROOT_FIXED</a></td></tr>

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

  106. <tr class="memitem:a666774999b9afd627fdad75471101581"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a666774999b9afd627fdad75471101581">FAT_FILE_TYPE_NORMAL</a> = 1</td></tr>

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

  108. <tr class="memitem:a9a1a07cb1d09cfdb3cc53183c6e5dc57"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a9a1a07cb1d09cfdb3cc53183c6e5dc57">FAT_FILE_TYPE_ROOT32</a> = 3</td></tr>

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

  110. <tr class="memitem:a1bb2e8f6b6f90bbf4d02608cd267af42"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#a1bb2e8f6b6f90bbf4d02608cd267af42">FAT_FILE_TYPE_ROOT_FIXED</a> = 2</td></tr>

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

  112. <tr class="memitem:ac301b0465fdd7953c6e110b9896cc9fd"><td class="memItemLeft" align="right" valign="top">uint8_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_base_file_8h.html#ac301b0465fdd7953c6e110b9896cc9fd">FAT_FILE_TYPE_SUBDIR</a> = 4</td></tr>

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

  114. </table>

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

  116. <div class="textblock"><p><a class="el" href="class_sd_base_file.html" title="Base class for SdFile with Print and C++ streams. ">SdBaseFile</a> class. </p>

  117. </div><h2 class="groupheader">Macro Definition Documentation</h2>

  118. <a class="anchor" id="a963f816fc88a5d8479c285ed4c630229"></a>

  119. <div class="memitem">

  120. <div class="memproto">

  121.       <table class="memname">

  122.         <tr>

  123.           <td class="memname">#define PGM_P&#160;&#160;&#160;const char*</td>

  124.         </tr>

  125.       </table>

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

  127. <p>pointer to flash for ARM </p>

  128. 

  129. </div>

  130. </div>

  131. <a class="anchor" id="a48c60b057902adf805797f183286728d"></a>

  132. <div class="memitem">

  133. <div class="memproto">

  134.       <table class="memname">

  135.         <tr>

  136.           <td class="memname">#define pgm_read_byte</td>

  137.           <td>(</td>

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

  139.           <td class="paramname">addr</td><td>)</td>

  140.           <td>&#160;&#160;&#160;(*(const unsigned char*)(addr))</td>

  141.         </tr>

  142.       </table>

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

  144. <p>read 8-bits from flash for ARM </p>

  145. 

  146. </div>

  147. </div>

  148. <a class="anchor" id="a910fb5f01313d339d3b835d45e1e5ad0"></a>

  149. <div class="memitem">

  150. <div class="memproto">

  151.       <table class="memname">

  152.         <tr>

  153.           <td class="memname">#define pgm_read_word</td>

  154.           <td>(</td>

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

  156.           <td class="paramname">addr</td><td>)</td>

  157.           <td>&#160;&#160;&#160;(*(const uint16_t*)(addr))</td>

  158.         </tr>

  159.       </table>

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

  161. <p>read 16-bits from flash for ARM </p>

  162. 

  163. </div>

  164. </div>

  165. <a class="anchor" id="a75acaba9e781937468d0911423bc0c35"></a>

  166. <div class="memitem">

  167. <div class="memproto">

  168.       <table class="memname">

  169.         <tr>

  170.           <td class="memname">#define PROGMEM&#160;&#160;&#160;const</td>

  171.         </tr>

  172.       </table>

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

  174. <p>store in flash for ARM </p>

  175. 

  176. </div>

  177. </div>

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

  179. <div class="memitem">

  180. <div class="memproto">

  181.       <table class="memname">

  182.         <tr>

  183.           <td class="memname">#define PSTR</td>

  184.           <td>(</td>

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

  186.           <td class="paramname">x</td><td>)</td>

  187.           <td>&#160;&#160;&#160;(x)</td>

  188.         </tr>

  189.       </table>

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

  191. <p>store literal string in flash for ARM </p>

  192. 

  193. </div>

  194. </div>

  195. <h2 class="groupheader">Variable Documentation</h2>

  196. <a class="anchor" id="a4da8c96e256b06356321e81705494010"></a>

  197. <div class="memitem">

  198. <div class="memproto">

  199.       <table class="memname">

  200.         <tr>

  201.           <td class="memname">uint8_t const FAT_FILE_TYPE_CLOSED = 0</td>

  202.         </tr>

  203.       </table>

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

  205. <p>This file has not been opened. </p>

  206. 

  207. </div>

  208. </div>

  209. <a class="anchor" id="abc9b0906aeeedfe122b0ca629bac889b"></a>

  210. <div class="memitem">

  211. <div class="memproto">

  212.       <table class="memname">

  213.         <tr>

  214.           <td class="memname">uint8_t const FAT_FILE_TYPE_MIN_DIR = <a class="el" href="_sd_base_file_8h.html#a1bb2e8f6b6f90bbf4d02608cd267af42">FAT_FILE_TYPE_ROOT_FIXED</a></td>

  215.         </tr>

  216.       </table>

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

  218. <p>Test value for directory type </p>

  219. 

  220. </div>

  221. </div>

  222. <a class="anchor" id="a666774999b9afd627fdad75471101581"></a>

  223. <div class="memitem">

  224. <div class="memproto">

  225.       <table class="memname">

  226.         <tr>

  227.           <td class="memname">uint8_t const FAT_FILE_TYPE_NORMAL = 1</td>

  228.         </tr>

  229.       </table>

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

  231. <p>A normal file </p>

  232. 

  233. </div>

  234. </div>

  235. <a class="anchor" id="a9a1a07cb1d09cfdb3cc53183c6e5dc57"></a>

  236. <div class="memitem">

  237. <div class="memproto">

  238.       <table class="memname">

  239.         <tr>

  240.           <td class="memname">uint8_t const FAT_FILE_TYPE_ROOT32 = 3</td>

  241.         </tr>

  242.       </table>

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

  244. <p>A FAT32 root directory </p>

  245. 

  246. </div>

  247. </div>

  248. <a class="anchor" id="a1bb2e8f6b6f90bbf4d02608cd267af42"></a>

  249. <div class="memitem">

  250. <div class="memproto">

  251.       <table class="memname">

  252.         <tr>

  253.           <td class="memname">uint8_t const FAT_FILE_TYPE_ROOT_FIXED = 2</td>

  254.         </tr>

  255.       </table>

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

  257. <p>A FAT12 or FAT16 root directory </p>

  258. 

  259. </div>

  260. </div>

  261. <a class="anchor" id="ac301b0465fdd7953c6e110b9896cc9fd"></a>

  262. <div class="memitem">

  263. <div class="memproto">

  264.       <table class="memname">

  265.         <tr>

  266.           <td class="memname">uint8_t const FAT_FILE_TYPE_SUBDIR = 4</td>

  267.         </tr>

  268.       </table>

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

  270. <p>A subdirectory file </p>

  271. 

  272. </div>

  273. </div>

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

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

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

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

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

  279. </a> 1.8.8

  280. </small></address>

  281. </body>

  282. </html>