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

284 lines
18KB
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: 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.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><a href="annotated.html"><span>Classes</span></a></li>

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

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

  41.     </ul>

  42.   </div>

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

  44.   <ul>

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

  46. </div>

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

  48. <div class="header">

  49.   <div class="summary">

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

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

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

  53.   <div class="headertitle">

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

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

  56. <div class="contents">

  57. 

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

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

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

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

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

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

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

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

  66. <div class="dyncontent">

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

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

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

  70. </div>

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

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

  73. <div class="dyncontent">

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

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

  76. <area shape="rect" id="node3" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="843,97,997,138"/>
<area shape="rect" id="node32" href="_stdio_stream_8h.html" title="Arduino/libraries/SdFat\l/StdioStream.h" alt="" coords="1307,641,1461,682"/>
<area shape="rect" id="node36" href="_sd_stream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="533,369,688,410"/>
<area shape="rect" id="node46" href="_sd_file_8h.html" title="SdFile class. " alt="" coords="1021,97,1176,138"/>
<area shape="rect" id="node5" href="istream_8h.html" title="istream class " alt="" coords="696,187,851,229"/>
<area shape="rect" id="node41" href="ostream_8h.html" title="ostream class " alt="" coords="875,187,1029,229"/>
<area shape="rect" id="node7" href="iostream_8h.html" title="iostream class " alt="" coords="712,278,867,319"/>
<area shape="rect" id="node39" href="istream_8cpp.html" title="Arduino/libraries/SdFat\l/istream.cpp" alt="" coords="533,278,688,319"/>
<area shape="rect" id="node9" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="712,369,867,410"/>
<area shape="rect" id="node11" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="680,459,835,501"/>
<area shape="rect" id="node13" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="664,550,819,591"/>
<area shape="rect" id="node15" href="_sd_base_file_8cpp.html" title="Arduino/libraries/SdFat\l/SdBaseFile.cpp" alt="" coords="1128,641,1283,682"/>
<area shape="rect" id="node17" href="_sd_base_file_print_8cpp.html" title="Arduino/libraries/SdFat\l/SdBaseFilePrint.cpp" alt="" coords="5,641,160,682"/>
<area shape="rect" id="node19" href="_sd_fat_8cpp.html" title="Arduino/libraries/SdFat\l/SdFat.cpp" alt="" coords="184,641,339,682"/>
<area shape="rect" id="node21" href="_sd_fat_error_print_8cpp.html" title="Arduino/libraries/SdFat\l/SdFatErrorPrint.cpp" alt="" coords="363,641,517,682"/>
<area shape="rect" id="node23" href="_sd_fat_util_8cpp.html" title="Arduino/libraries/SdFat\l/SdFatUtil.cpp" alt="" coords="599,731,753,773"/>
<area shape="rect" id="node25" href="_sd_fat_util_8h.html" title="Useful utility functions. " alt="" coords="541,641,696,682"/>
<area shape="rect" id="node28" href="_sd_stream_8cpp.html" title="Arduino/libraries/SdFat\l/SdStream.cpp" alt="" coords="771,641,925,682"/>
<area shape="rect" id="node30" href="_sd_volume_8cpp.html" title="Arduino/libraries/SdFat\l/SdVolume.cpp" alt="" coords="949,641,1104,682"/>
<area shape="rect" id="node34" href="_stdio_stream_8cpp.html" title="Arduino/libraries/SdFat\l/StdioStream.cpp" alt="" coords="1307,731,1461,773"/>
<area shape="rect" id="node44" href="ostream_8cpp.html" title="Arduino/libraries/SdFat\l/ostream.cpp" alt="" coords="891,278,1045,319"/>
<area shape="rect" id="node49" href="_sd_file_8cpp.html" title="Arduino/libraries/SdFat\l/SdFile.cpp" alt="" coords="1120,187,1275,229"/>
</map>

  77. </div>

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

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

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

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

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

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

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

  85. <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 Print. ">SdFile</a> with Print and C++ streams.  <a href="class_sd_base_file.html#details">More...</a><br/></td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  115. </table>

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

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

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

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

  120. <div class="memitem">

  121. <div class="memproto">

  122.       <table class="memname">

  123.         <tr>

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

  125.         </tr>

  126.       </table>

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

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

  129. 

  130. </div>

  131. </div>

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

  133. <div class="memitem">

  134. <div class="memproto">

  135.       <table class="memname">

  136.         <tr>

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

  138.           <td>(</td>

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

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

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

  142.         </tr>

  143.       </table>

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

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

  146. 

  147. </div>

  148. </div>

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

  150. <div class="memitem">

  151. <div class="memproto">

  152.       <table class="memname">

  153.         <tr>

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

  155.           <td>(</td>

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

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

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

  159.         </tr>

  160.       </table>

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

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

  163. 

  164. </div>

  165. </div>

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

  167. <div class="memitem">

  168. <div class="memproto">

  169.       <table class="memname">

  170.         <tr>

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

  172.         </tr>

  173.       </table>

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

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

  176. 

  177. </div>

  178. </div>

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

  180. <div class="memitem">

  181. <div class="memproto">

  182.       <table class="memname">

  183.         <tr>

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

  185.           <td>(</td>

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

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

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

  189.         </tr>

  190.       </table>

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

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

  193. 

  194. </div>

  195. </div>

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

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

  198. <div class="memitem">

  199. <div class="memproto">

  200.       <table class="memname">

  201.         <tr>

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

  203.         </tr>

  204.       </table>

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

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

  207. 

  208. </div>

  209. </div>

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

  211. <div class="memitem">

  212. <div class="memproto">

  213.       <table class="memname">

  214.         <tr>

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

  216.         </tr>

  217.       </table>

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

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

  220. 

  221. </div>

  222. </div>

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

  224. <div class="memitem">

  225. <div class="memproto">

  226.       <table class="memname">

  227.         <tr>

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

  229.         </tr>

  230.       </table>

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

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

  233. 

  234. </div>

  235. </div>

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

  237. <div class="memitem">

  238. <div class="memproto">

  239.       <table class="memname">

  240.         <tr>

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

  242.         </tr>

  243.       </table>

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

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

  246. 

  247. </div>

  248. </div>

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

  250. <div class="memitem">

  251. <div class="memproto">

  252.       <table class="memname">

  253.         <tr>

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

  255.         </tr>

  256.       </table>

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

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

  259. 

  260. </div>

  261. </div>

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

  263. <div class="memitem">

  264. <div class="memproto">

  265.       <table class="memname">

  266.         <tr>

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

  268.         </tr>

  269.       </table>

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

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

  272. 

  273. </div>

  274. </div>

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

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

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

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

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

  280. </a> 1.8.6

  281. </small></address>

  282. </body>

  283. </html>