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.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/_sd_fat_8h.html

211 lines
13KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>SdFat: ArduinoSdFat/libraries/SdFat/src/SdFat.h File 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.16 -->

  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. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

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

  63.   <ul>

  64. <li class="navelem"><a class="el" href="dir_bd3b508a448b79faa7486a2af0c5c4a2.html">ArduinoSdFat</a></li><li class="navelem"><a class="el" href="dir_d7cdc5eb6907b67ec8d6facf0ac28083.html">libraries</a></li><li class="navelem"><a class="el" href="dir_30f4e013e11264f0426cd7e4f10b230b.html">SdFat</a></li><li class="navelem"><a class="el" href="dir_ffa9b8a1695a52c2b9469cb7873a40f4.html">src</a></li>  </ul>

  65. </div>

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

  67. <div class="header">

  68.   <div class="summary">

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

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

  71. <a href="#typedef-members">Typedefs</a>  </div>

  72.   <div class="headertitle">

  73. <div class="title">SdFat.h File Reference</div>  </div>

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

  75. <div class="contents">

  76. 

  77. <p>main <a class="el" href="class_sd_fs.html" title="SD file system class for FAT16, FAT32, and exFAT volumes.">SdFs</a> include file.  

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

  79. <div class="textblock"><code>#include &quot;<a class="el" href="_sys_call_8h.html">common/SysCall.h</a>&quot;</code><br />

  80. <code>#include &quot;SdCard/SdCard.h&quot;</code><br />

  81. <code>#include &quot;ExFatLib/ExFatLib.h&quot;</code><br />

  82. <code>#include &quot;FatLib/FatLib.h&quot;</code><br />

  83. <code>#include &quot;<a class="el" href="_fs_lib_8h.html">FsLib/FsLib.h</a>&quot;</code><br />

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

  85. Include dependency graph for SdFat.h:</div>

  86. <div class="dyncontent">

  87. <div class="center"><img src="_sd_fat_8h__incl.png" border="0" usemap="#_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_8h" alt=""/></div>

  88. <map name="_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_8h" id="_arduino_sd_fat_2libraries_2_sd_fat_2src_2_sd_fat_8h">

  89. <area shape="rect" title="main SdFs include file." alt="" coords="58,5,208,47"/>

  90. <area shape="rect" href="_sys_call_8h.html" title="SysCall class." alt="" coords="67,95,199,121"/>

  91. <area shape="rect" title=" " alt="" coords="100,244,166,271"/>

  92. <area shape="rect" href="_fs_lib_8h.html" title="FsLib include file." alt="" coords="306,95,408,121"/>

  93. <area shape="rect" title=" " alt="" coords="27,169,95,196"/>

  94. <area shape="rect" href="_sd_fat_config_8h.html" title="configuration definitions" alt="" coords="171,169,287,196"/>

  95. <area shape="rect" title=" " alt="" coords="190,244,268,271"/>

  96. <area shape="rect" href="_fs_volume_8h.html" title="FsVolume include file." alt="" coords="311,169,403,196"/>

  97. <area shape="rect" href="_fs_file_8h.html" title="FsBaseFile include file." alt="" coords="428,169,497,196"/>

  98. </map>

  99. </div>

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

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

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

  103. <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.html">SdBase&lt; Vol &gt;</a></td></tr>

  104. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">base SD file system template class.  <a href="class_sd_base.html#details">More...</a><br /></td></tr>

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

  106. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_ex_fat.html">SdExFat</a></td></tr>

  107. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">SD file system class for exFAT volumes.  <a href="class_sd_ex_fat.html#details">More...</a><br /></td></tr>

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

  109. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fat32.html">SdFat32</a></td></tr>

  110. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">SD file system class for FAT volumes.  <a href="class_sd_fat32.html#details">More...</a><br /></td></tr>

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

  112. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_file.html">SdFile</a></td></tr>

  113. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FAT16/FAT32 file with Print.  <a href="class_sd_file.html#details">More...</a><br /></td></tr>

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

  115. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_fs.html">SdFs</a></td></tr>

  116. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">SD file system class for FAT16, FAT32, and exFAT volumes.  <a href="class_sd_fs.html#details">More...</a><br /></td></tr>

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

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

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

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

  121. <tr class="memitem:aca25ecce379f446043bdee2c55304210"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_8h.html#aca25ecce379f446043bdee2c55304210">SD_FAT_VERSION</a>&#160;&#160;&#160;&quot;2.0.0&quot;</td></tr>

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

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

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

  125. Typedefs</h2></td></tr>

  126. <tr class="memitem:aa0ffd23c3e43af0bcbd2fb4d62f3286d"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="class_file32.html">File32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_8h.html#aa0ffd23c3e43af0bcbd2fb4d62f3286d">File</a></td></tr>

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

  128. <tr class="memitem:a3991b0f70199d1a17dbb837bb041e89c"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="class_fat_file.html">FatFile</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_8h.html#a3991b0f70199d1a17dbb837bb041e89c">SdBaseFile</a></td></tr>

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

  130. <tr class="memitem:a6e295d38f798fdc044c3282818cdb064"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="class_sd_fat32.html">SdFat32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sd_fat_8h.html#a6e295d38f798fdc044c3282818cdb064">SdFat</a></td></tr>

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

  132. </table>

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

  134. <div class="textblock"><p>main <a class="el" href="class_sd_fs.html" title="SD file system class for FAT16, FAT32, and exFAT volumes.">SdFs</a> include file. </p>

  135. <p>Copyright (c) 2011-2019 Bill Greiman This file is part of the SdFat library for SD memory cards.</p>

  136. <p>MIT License</p>

  137. <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>

  138. <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>

  139. <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>

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

  141. <a id="aca25ecce379f446043bdee2c55304210"></a>

  142. <h2 class="memtitle"><span class="permalink"><a href="#aca25ecce379f446043bdee2c55304210">&#9670;&nbsp;</a></span>SD_FAT_VERSION</h2>

  143. 

  144. <div class="memitem">

  145. <div class="memproto">

  146.       <table class="memname">

  147.         <tr>

  148.           <td class="memname">#define SD_FAT_VERSION&#160;&#160;&#160;&quot;2.0.0&quot;</td>

  149.         </tr>

  150.       </table>

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

  152. <p>SdFat version </p>

  153. 

  154. </div>

  155. </div>

  156. <h2 class="groupheader">Typedef Documentation</h2>

  157. <a id="aa0ffd23c3e43af0bcbd2fb4d62f3286d"></a>

  158. <h2 class="memtitle"><span class="permalink"><a href="#aa0ffd23c3e43af0bcbd2fb4d62f3286d">&#9670;&nbsp;</a></span>File</h2>

  159. 

  160. <div class="memitem">

  161. <div class="memproto">

  162.       <table class="memname">

  163.         <tr>

  164.           <td class="memname">typedef <a class="el" href="class_file32.html">File32</a> <a class="el" href="_sd_fat_8h.html#aa0ffd23c3e43af0bcbd2fb4d62f3286d">File</a></td>

  165.         </tr>

  166.       </table>

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

  168. <p>Select type for File. </p>

  169. 

  170. </div>

  171. </div>

  172. <a id="a3991b0f70199d1a17dbb837bb041e89c"></a>

  173. <h2 class="memtitle"><span class="permalink"><a href="#a3991b0f70199d1a17dbb837bb041e89c">&#9670;&nbsp;</a></span>SdBaseFile</h2>

  174. 

  175. <div class="memitem">

  176. <div class="memproto">

  177.       <table class="memname">

  178.         <tr>

  179.           <td class="memname">typedef <a class="el" href="class_fat_file.html">FatFile</a> <a class="el" href="_sd_fat_8h.html#a3991b0f70199d1a17dbb837bb041e89c">SdBaseFile</a></td>

  180.         </tr>

  181.       </table>

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

  183. <p>Select type for SdBaseFile. </p>

  184. 

  185. </div>

  186. </div>

  187. <a id="a6e295d38f798fdc044c3282818cdb064"></a>

  188. <h2 class="memtitle"><span class="permalink"><a href="#a6e295d38f798fdc044c3282818cdb064">&#9670;&nbsp;</a></span>SdFat</h2>

  189. 

  190. <div class="memitem">

  191. <div class="memproto">

  192.       <table class="memname">

  193.         <tr>

  194.           <td class="memname">typedef <a class="el" href="class_sd_fat32.html">SdFat32</a> <a class="el" href="_sd_fat_8h.html#a6e295d38f798fdc044c3282818cdb064">SdFat</a></td>

  195.         </tr>

  196.       </table>

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

  198. <p>Select type for SdFat. </p>

  199. 

  200. </div>

  201. </div>

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

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

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

  205. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  207. </a> 1.8.16

  208. </small></address>

  209. </body>

  210. </html>