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.

238 lines
11KB

  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.10"/>
  7. <title>SdFat: longDirectoryEntry Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">SdFat
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  66. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. </div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. </div><!-- top -->
  82. <div class="header">
  83. <div class="summary">
  84. <a href="#pub-attribs">Public Attributes</a> &#124;
  85. <a href="structlong_directory_entry-members.html">List of all members</a> </div>
  86. <div class="headertitle">
  87. <div class="title">longDirectoryEntry Struct Reference</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <p>FAT long directory entry.
  91. <a href="structlong_directory_entry.html#details">More...</a></p>
  92. <p><code>#include &lt;FatStructs.h&gt;</code></p>
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  95. Public Attributes</h2></td></tr>
  96. <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>
  97. <tr class="separator:aa36bf1210d0c2b3b80948e5f697eb02e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:a60c35531bc0e12f2d764d290244f8cc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:af3055930e869875e49b32ef0b49c3649"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:a629f1ca5ba2ccce6cac5295578b6e7b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:ad763b5a3da4b8d326d9888493fbb819a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:a6f14c81b7d224dc4431217f92601257a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:a1b65e85dd63d0708cd1b875ce4e5e338"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:a9adb019dbf24cce65c8d1419cd000f91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table>
  113. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  114. <div class="textblock"><p>FAT long directory entry. </p>
  115. </div><h2 class="groupheader">Member Data Documentation</h2>
  116. <a class="anchor" id="aa36bf1210d0c2b3b80948e5f697eb02e"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">uint8_t longDirectoryEntry::attr</td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>Attributes - must be ATTR_LONG_NAME </p>
  126. </div>
  127. </div>
  128. <a class="anchor" id="a60c35531bc0e12f2d764d290244f8cc9"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">uint8_t longDirectoryEntry::chksum</td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>Checksum of name in the short dir entry at the end of the long dir set. </p>
  138. </div>
  139. </div>
  140. <a class="anchor" id="af3055930e869875e49b32ef0b49c3649"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">uint16_t longDirectoryEntry::mustBeZero</td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Must be ZERO. This is an artifact of the FAT "first cluster" </p>
  150. </div>
  151. </div>
  152. <a class="anchor" id="a629f1ca5ba2ccce6cac5295578b6e7b4"></a>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">uint16_t longDirectoryEntry::name1[<a class="el" href="_fat_structs_8h.html#af843af29c67dd30ca7c5684806bf02fc">LDIR_NAME1_DIM</a>]</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Characters 1-5 of the long-name sub-component in this entry. </p>
  162. </div>
  163. </div>
  164. <a class="anchor" id="ad763b5a3da4b8d326d9888493fbb819a"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">uint16_t longDirectoryEntry::name2[<a class="el" href="_fat_structs_8h.html#a99cae591c59e261f54617617e173e7e0">LDIR_NAME2_DIM</a>]</td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>Characters 6-11 of the long-name sub-component in this entry. </p>
  174. </div>
  175. </div>
  176. <a class="anchor" id="a6f14c81b7d224dc4431217f92601257a"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">uint16_t longDirectoryEntry::name3[<a class="el" href="_fat_structs_8h.html#a99fbd27fa9e5003a8d77ca7fc14d2090">LDIR_NAME3_DIM</a>]</td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Characters 12 and 13 of the long-name sub-component in this entry. </p>
  186. </div>
  187. </div>
  188. <a class="anchor" id="a1b65e85dd63d0708cd1b875ce4e5e338"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">uint8_t longDirectoryEntry::ord</td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <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>
  198. <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>
  199. </div>
  200. </div>
  201. <a class="anchor" id="a9adb019dbf24cce65c8d1419cd000f91"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">uint8_t longDirectoryEntry::type</td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <p>If zero, indicates a directory entry that is a sub-component of a long name. NOTE: Other values reserved for future extensions.</p>
  211. <p>Non-zero implies other directory entry types. </p>
  212. </div>
  213. </div>
  214. <hr/>The documentation for this struct was generated from the following file:<ul>
  215. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_structs_8h.html">FatStructs.h</a></li>
  216. </ul>
  217. </div><!-- contents -->
  218. <!-- start footer part -->
  219. <hr class="footer"/><address class="footer"><small>
  220. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  221. <img class="footer" src="doxygen.png" alt="doxygen"/>
  222. </a> 1.8.10
  223. </small></address>
  224. </body>
  225. </html>