structlong_directory_entry.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  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: longDirectoryEntry 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="structlong_directory_entry-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">longDirectoryEntry Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>FAT long directory entry.
  70. <a href="structlong_directory_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:aa36bf1210d0c2b3b80948e5f697eb02e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#aa36bf1210d0c2b3b80948e5f697eb02e">attr</a></td></tr>
  76. <tr class="separator:aa36bf1210d0c2b3b80948e5f697eb02e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a60c35531bc0e12f2d764d290244f8cc9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#a60c35531bc0e12f2d764d290244f8cc9">chksum</a></td></tr>
  78. <tr class="separator:a60c35531bc0e12f2d764d290244f8cc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:af3055930e869875e49b32ef0b49c3649"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#af3055930e869875e49b32ef0b49c3649">mustBeZero</a></td></tr>
  80. <tr class="separator:af3055930e869875e49b32ef0b49c3649"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a629f1ca5ba2ccce6cac5295578b6e7b4"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#a629f1ca5ba2ccce6cac5295578b6e7b4">name1</a> [<a class="el" href="_fat_structs_8h.html#af843af29c67dd30ca7c5684806bf02fc">LDIR_NAME1_DIM</a>]</td></tr>
  82. <tr class="separator:a629f1ca5ba2ccce6cac5295578b6e7b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ad763b5a3da4b8d326d9888493fbb819a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#ad763b5a3da4b8d326d9888493fbb819a">name2</a> [<a class="el" href="_fat_structs_8h.html#a99cae591c59e261f54617617e173e7e0">LDIR_NAME2_DIM</a>]</td></tr>
  84. <tr class="separator:ad763b5a3da4b8d326d9888493fbb819a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a6f14c81b7d224dc4431217f92601257a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#a6f14c81b7d224dc4431217f92601257a">name3</a> [<a class="el" href="_fat_structs_8h.html#a99fbd27fa9e5003a8d77ca7fc14d2090">LDIR_NAME3_DIM</a>]</td></tr>
  86. <tr class="separator:a6f14c81b7d224dc4431217f92601257a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a1b65e85dd63d0708cd1b875ce4e5e338"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#a1b65e85dd63d0708cd1b875ce4e5e338">ord</a></td></tr>
  88. <tr class="separator:a1b65e85dd63d0708cd1b875ce4e5e338"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a9adb019dbf24cce65c8d1419cd000f91"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlong_directory_entry.html#a9adb019dbf24cce65c8d1419cd000f91">type</a></td></tr>
  90. <tr class="separator:a9adb019dbf24cce65c8d1419cd000f91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table>
  92. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  93. <div class="textblock"><p>FAT long directory entry. </p>
  94. </div><h2 class="groupheader">Member Data Documentation</h2>
  95. <a id="aa36bf1210d0c2b3b80948e5f697eb02e"></a>
  96. <h2 class="memtitle"><span class="permalink"><a href="#aa36bf1210d0c2b3b80948e5f697eb02e">&#9670;&nbsp;</a></span>attr</h2>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">uint8_t longDirectoryEntry::attr</td>
  102. </tr>
  103. </table>
  104. </div><div class="memdoc">
  105. <p>Attributes - must be ATTR_LONG_NAME </p>
  106. </div>
  107. </div>
  108. <a id="a60c35531bc0e12f2d764d290244f8cc9"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#a60c35531bc0e12f2d764d290244f8cc9">&#9670;&nbsp;</a></span>chksum</h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname">uint8_t longDirectoryEntry::chksum</td>
  115. </tr>
  116. </table>
  117. </div><div class="memdoc">
  118. <p>Checksum of name in the short dir entry at the end of the long dir set. </p>
  119. </div>
  120. </div>
  121. <a id="af3055930e869875e49b32ef0b49c3649"></a>
  122. <h2 class="memtitle"><span class="permalink"><a href="#af3055930e869875e49b32ef0b49c3649">&#9670;&nbsp;</a></span>mustBeZero</h2>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">uint16_t longDirectoryEntry::mustBeZero</td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. <p>Must be ZERO. This is an artifact of the FAT "first cluster" </p>
  132. </div>
  133. </div>
  134. <a id="a629f1ca5ba2ccce6cac5295578b6e7b4"></a>
  135. <h2 class="memtitle"><span class="permalink"><a href="#a629f1ca5ba2ccce6cac5295578b6e7b4">&#9670;&nbsp;</a></span>name1</h2>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">uint16_t longDirectoryEntry::name1[<a class="el" href="_fat_structs_8h.html#af843af29c67dd30ca7c5684806bf02fc">LDIR_NAME1_DIM</a>]</td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Characters 1-5 of the long-name sub-component in this entry. </p>
  145. </div>
  146. </div>
  147. <a id="ad763b5a3da4b8d326d9888493fbb819a"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#ad763b5a3da4b8d326d9888493fbb819a">&#9670;&nbsp;</a></span>name2</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">uint16_t longDirectoryEntry::name2[<a class="el" href="_fat_structs_8h.html#a99cae591c59e261f54617617e173e7e0">LDIR_NAME2_DIM</a>]</td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>Characters 6-11 of the long-name sub-component in this entry. </p>
  158. </div>
  159. </div>
  160. <a id="a6f14c81b7d224dc4431217f92601257a"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#a6f14c81b7d224dc4431217f92601257a">&#9670;&nbsp;</a></span>name3</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">uint16_t longDirectoryEntry::name3[<a class="el" href="_fat_structs_8h.html#a99fbd27fa9e5003a8d77ca7fc14d2090">LDIR_NAME3_DIM</a>]</td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <p>Characters 12 and 13 of the long-name sub-component in this entry. </p>
  171. </div>
  172. </div>
  173. <a id="a1b65e85dd63d0708cd1b875ce4e5e338"></a>
  174. <h2 class="memtitle"><span class="permalink"><a href="#a1b65e85dd63d0708cd1b875ce4e5e338">&#9670;&nbsp;</a></span>ord</h2>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">uint8_t longDirectoryEntry::ord</td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>The order of this entry in the sequence of long dir entries associated with the short dir entry at the end of the long dir set.</p>
  184. <p>If masked with 0X40 (LAST_LONG_ENTRY), this indicates the entry is the last long dir entry in a set of long dir entries. All valid sets of long dir entries must begin with an entry having this mask. </p>
  185. </div>
  186. </div>
  187. <a id="a9adb019dbf24cce65c8d1419cd000f91"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#a9adb019dbf24cce65c8d1419cd000f91">&#9670;&nbsp;</a></span>type</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">uint8_t longDirectoryEntry::type</td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>If zero, indicates a directory entry that is a sub-component of a long name. NOTE: Other values reserved for future extensions.</p>
  198. <p>Non-zero implies other directory entry types. </p>
  199. </div>
  200. </div>
  201. <hr/>The documentation for this struct was generated from the following file:<ul>
  202. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_structs_8h.html">FatStructs.h</a></li>
  203. </ul>
  204. </div><!-- contents -->
  205. <!-- start footer part -->
  206. <hr class="footer"/><address class="footer"><small>
  207. Generated on Fri Dec 28 2018 06:38:31 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  208. <img class="footer" src="doxygen.png" alt="doxygen"/>
  209. </a> 1.8.14
  210. </small></address>
  211. </body>
  212. </html>