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.

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