structdirectory_entry.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  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.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: directoryEntry Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.14 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-attribs">Public Attributes</a> &#124;
  64. <a href="structdirectory_entry-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">directoryEntry Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>FAT short directory entry.
  70. <a href="structdirectory_entry.html#details">More...</a></p>
  71. <p><code>#include &lt;FatStructs.h&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  74. Public Attributes</h2></td></tr>
  75. <tr class="memitem:a16c6cde55c8175c90935c386f1cfb21a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a16c6cde55c8175c90935c386f1cfb21a">attributes</a></td></tr>
  76. <tr class="separator:a16c6cde55c8175c90935c386f1cfb21a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a7b43372794655fe6604d3c17c02302fe"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a7b43372794655fe6604d3c17c02302fe">creationDate</a></td></tr>
  78. <tr class="separator:a7b43372794655fe6604d3c17c02302fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a622bfa70c2cd9006108d7473d737a953"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a622bfa70c2cd9006108d7473d737a953">creationTime</a></td></tr>
  80. <tr class="separator:a622bfa70c2cd9006108d7473d737a953"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:aa5e1ce5b411b88f005b28a3e7c7c5af6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#aa5e1ce5b411b88f005b28a3e7c7c5af6">creationTimeTenths</a></td></tr>
  82. <tr class="separator:aa5e1ce5b411b88f005b28a3e7c7c5af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ac2445d99b50f925f662952e0ccd26a02"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#ac2445d99b50f925f662952e0ccd26a02">fileSize</a></td></tr>
  84. <tr class="separator:ac2445d99b50f925f662952e0ccd26a02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a3b492598b2b05e8425d2a500443613bd"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a3b492598b2b05e8425d2a500443613bd">firstClusterHigh</a></td></tr>
  86. <tr class="separator:a3b492598b2b05e8425d2a500443613bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a74bd660417a9c3501eae353326c14bb9"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a74bd660417a9c3501eae353326c14bb9">firstClusterLow</a></td></tr>
  88. <tr class="separator:a74bd660417a9c3501eae353326c14bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:abca70dc5c5fcbe199fd78df010111331"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#abca70dc5c5fcbe199fd78df010111331">lastAccessDate</a></td></tr>
  90. <tr class="separator:abca70dc5c5fcbe199fd78df010111331"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a12b2e7cf87482a942a0b5d3df6c51468"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a12b2e7cf87482a942a0b5d3df6c51468">lastWriteDate</a></td></tr>
  92. <tr class="separator:a12b2e7cf87482a942a0b5d3df6c51468"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a7bab435322d1928f66fbce53ee1f402d"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a7bab435322d1928f66fbce53ee1f402d">lastWriteTime</a></td></tr>
  94. <tr class="separator:a7bab435322d1928f66fbce53ee1f402d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a05dc993ea55a1a742de5970541a31ecb"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a05dc993ea55a1a742de5970541a31ecb">name</a> [11]</td></tr>
  96. <tr class="separator:a05dc993ea55a1a742de5970541a31ecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:afe7d00be85f3b78549b21610050da52b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#afe7d00be85f3b78549b21610050da52b">reservedNT</a></td></tr>
  98. <tr class="separator:afe7d00be85f3b78549b21610050da52b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <div class="textblock"><p>FAT short directory entry. </p>
  102. <p>Short means short 8.3 name, not the entry size.</p>
  103. <p>Date Format. A FAT directory entry date stamp is a 16-bit field that is basically a date relative to the MS-DOS epoch of 01/01/1980. Here is the format (bit 0 is the LSB of the 16-bit word, bit 15 is the MSB of the 16-bit word):</p>
  104. <p>Bits 9-15: Count of years from 1980, valid value range 0-127 inclusive (1980-2107).</p>
  105. <p>Bits 5-8: Month of year, 1 = January, valid value range 1-12 inclusive.</p>
  106. <p>Bits 0-4: Day of month, valid value range 1-31 inclusive.</p>
  107. <p>Time Format. A FAT directory entry time stamp is a 16-bit field that has a granularity of 2 seconds. Here is the format (bit 0 is the LSB of the 16-bit word, bit 15 is the MSB of the 16-bit word).</p>
  108. <p>Bits 11-15: Hours, valid value range 0-23 inclusive.</p>
  109. <p>Bits 5-10: Minutes, valid value range 0-59 inclusive.</p>
  110. <p>Bits 0-4: 2-second count, valid value range 0-29 inclusive (0 - 58 seconds).</p>
  111. <p>The valid time range is from Midnight 00:00:00 to 23:59:58. </p>
  112. </div><h2 class="groupheader">Member Data Documentation</h2>
  113. <a id="a16c6cde55c8175c90935c386f1cfb21a"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#a16c6cde55c8175c90935c386f1cfb21a">&#9670;&nbsp;</a></span>attributes</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">uint8_t directoryEntry::attributes</td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Entry attributes.</p>
  124. <p>The upper two bits of the attribute byte are reserved and should always be set to 0 when a file is created and never modified or looked at after that. See defines that begin with DIR_ATT_. </p>
  125. </div>
  126. </div>
  127. <a id="a7b43372794655fe6604d3c17c02302fe"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#a7b43372794655fe6604d3c17c02302fe">&#9670;&nbsp;</a></span>creationDate</h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">uint16_t directoryEntry::creationDate</td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>Date file was created. </p>
  138. </div>
  139. </div>
  140. <a id="a622bfa70c2cd9006108d7473d737a953"></a>
  141. <h2 class="memtitle"><span class="permalink"><a href="#a622bfa70c2cd9006108d7473d737a953">&#9670;&nbsp;</a></span>creationTime</h2>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">uint16_t directoryEntry::creationTime</td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>Time file was created. </p>
  151. </div>
  152. </div>
  153. <a id="aa5e1ce5b411b88f005b28a3e7c7c5af6"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#aa5e1ce5b411b88f005b28a3e7c7c5af6">&#9670;&nbsp;</a></span>creationTimeTenths</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">uint8_t directoryEntry::creationTimeTenths</td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>The granularity of the seconds part of creationTime is 2 seconds so this field is a count of tenths of a second and its valid value range is 0-199 inclusive. (WHG note - seems to be hundredths) </p>
  164. </div>
  165. </div>
  166. <a id="ac2445d99b50f925f662952e0ccd26a02"></a>
  167. <h2 class="memtitle"><span class="permalink"><a href="#ac2445d99b50f925f662952e0ccd26a02">&#9670;&nbsp;</a></span>fileSize</h2>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">uint32_t directoryEntry::fileSize</td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>32-bit unsigned holding this file's size in bytes. </p>
  177. </div>
  178. </div>
  179. <a id="a3b492598b2b05e8425d2a500443613bd"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#a3b492598b2b05e8425d2a500443613bd">&#9670;&nbsp;</a></span>firstClusterHigh</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">uint16_t directoryEntry::firstClusterHigh</td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>High word of this entry's first cluster number (always 0 for a FAT12 or FAT16 volume). </p>
  190. </div>
  191. </div>
  192. <a id="a74bd660417a9c3501eae353326c14bb9"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#a74bd660417a9c3501eae353326c14bb9">&#9670;&nbsp;</a></span>firstClusterLow</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">uint16_t directoryEntry::firstClusterLow</td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Low word of this entry's first cluster number. </p>
  203. </div>
  204. </div>
  205. <a id="abca70dc5c5fcbe199fd78df010111331"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#abca70dc5c5fcbe199fd78df010111331">&#9670;&nbsp;</a></span>lastAccessDate</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">uint16_t directoryEntry::lastAccessDate</td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Last access date. Note that there is no last access time, only a date. This is the date of last read or write. In the case of a write, this should be set to the same date as lastWriteDate. </p>
  216. </div>
  217. </div>
  218. <a id="a12b2e7cf87482a942a0b5d3df6c51468"></a>
  219. <h2 class="memtitle"><span class="permalink"><a href="#a12b2e7cf87482a942a0b5d3df6c51468">&#9670;&nbsp;</a></span>lastWriteDate</h2>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">uint16_t directoryEntry::lastWriteDate</td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Date of last write. <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> creation is considered a write. </p>
  229. </div>
  230. </div>
  231. <a id="a7bab435322d1928f66fbce53ee1f402d"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#a7bab435322d1928f66fbce53ee1f402d">&#9670;&nbsp;</a></span>lastWriteTime</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">uint16_t directoryEntry::lastWriteTime</td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Time of last write. <a class="el" href="class_file.html" title="Arduino SD.h style File API. ">File</a> creation is considered a write. </p>
  242. </div>
  243. </div>
  244. <a id="a05dc993ea55a1a742de5970541a31ecb"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#a05dc993ea55a1a742de5970541a31ecb">&#9670;&nbsp;</a></span>name</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">uint8_t directoryEntry::name[11]</td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Short 8.3 name.</p>
  255. <p>The first eight bytes contain the file name with blank fill. The last three bytes contain the file extension with blank fill. </p>
  256. </div>
  257. </div>
  258. <a id="afe7d00be85f3b78549b21610050da52b"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#afe7d00be85f3b78549b21610050da52b">&#9670;&nbsp;</a></span>reservedNT</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">uint8_t directoryEntry::reservedNT</td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Reserved for use by Windows NT. Set value to 0 when a file is created and never modify or look at it after that. </p>
  269. </div>
  270. </div>
  271. <hr/>The documentation for this struct was generated from the following file:<ul>
  272. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_structs_8h.html">FatStructs.h</a></li>
  273. </ul>
  274. </div><!-- contents -->
  275. <!-- start footer part -->
  276. <hr class="footer"/><address class="footer"><small>
  277. Generated on Fri Dec 28 2018 06:38:31 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.14
  280. </small></address>
  281. </body>
  282. </html>