visus
/
teensy-sdfat
关注 1
点赞 0
派生 0
代码 工单 0 合并请求 0 版本发布 0 百科 动态
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
55 提交
1 分支
目录树: 56f3e4c857
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 '56f3e4c857'
${ noResults }
teensy-sdfat/extras/html/class_stream_file.html

516 行
23KB
原始文件 Blame 文件历史 

  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: StreamFile&lt; BaseFile, PosType &gt; Class Template 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><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="class_stream_file-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

  68. <div class="title">StreamFile&lt; BaseFile, PosType &gt; Class Template Reference</div>  </div>

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

  70. <div class="contents">

  71. 

  72. <p><a class="el" href="class_stream_file.html" title="StreamFile class.">StreamFile</a> class.  

  73.  <a href="class_stream_file.html#details">More...</a></p>

  74. 

  75. <p><code>#include &lt;ArduinoFiles.h&gt;</code></p>

  76. <div class="dynheader">

  77. Inheritance diagram for StreamFile&lt; BaseFile, PosType &gt;:</div>

  78. <div class="dyncontent">

  79. <div class="center"><img src="class_stream_file__inherit__graph.png" border="0" usemap="#_stream_file_3_01_base_file_00_01_pos_type_01_4_inherit__map" alt="Inheritance graph"/></div>

  80. <map name="_stream_file_3_01_base_file_00_01_pos_type_01_4_inherit__map" id="_stream_file_3_01_base_file_00_01_pos_type_01_4_inherit__map">

  81. <area shape="rect" title="StreamFile class." alt="" coords="14,80,166,121"/>

  82. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>

  83. <area shape="rect" title=" " alt="" coords="103,5,176,32"/>

  84. </map>

  85. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  86. <div class="dynheader">

  87. Collaboration diagram for StreamFile&lt; BaseFile, PosType &gt;:</div>

  88. <div class="dyncontent">

  89. <div class="center"><img src="class_stream_file__coll__graph.png" border="0" usemap="#_stream_file_3_01_base_file_00_01_pos_type_01_4_coll__map" alt="Collaboration graph"/></div>

  90. <map name="_stream_file_3_01_base_file_00_01_pos_type_01_4_coll__map" id="_stream_file_3_01_base_file_00_01_pos_type_01_4_coll__map">

  91. <area shape="rect" title="StreamFile class." alt="" coords="14,80,166,121"/>

  92. <area shape="rect" title=" " alt="" coords="5,5,79,32"/>

  93. <area shape="rect" title=" " alt="" coords="103,5,176,32"/>

  94. </map>

  95. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  96. <table class="memberdecls">

  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  98. Public Member Functions</h2></td></tr>

  99. <tr class="memitem:a0112cc39b64aac6f1ec47741397a7582"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a0112cc39b64aac6f1ec47741397a7582">available</a> ()</td></tr>

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

  101. <tr class="memitem:a32f813e659414892a58aa5157fe14f82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a32f813e659414892a58aa5157fe14f82">flush</a> ()</td></tr>

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

  103. <tr class="memitem:a586ad44055eca4c1b2b457299b829d44"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a586ad44055eca4c1b2b457299b829d44">isDirectory</a> ()</td></tr>

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

  105. <tr class="memitem:a8792c863080576eb65ce6cacbe1dd931"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a8792c863080576eb65ce6cacbe1dd931">name</a> () const</td></tr>

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

  107. <tr class="memitem:af0da96e502485133ca0cff27fa130082"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#af0da96e502485133ca0cff27fa130082">peek</a> ()</td></tr>

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

  109. <tr class="memitem:a18a04d1e68a0c1e3e38e5712cd9bbc03"><td class="memItemLeft" align="right" valign="top">PosType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a18a04d1e68a0c1e3e38e5712cd9bbc03">position</a> ()</td></tr>

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

  111. <tr class="memitem:a249a5d428f303e2a8e7c3ae476e74829"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a249a5d428f303e2a8e7c3ae476e74829">read</a> ()</td></tr>

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

  113. <tr class="memitem:a91e8cfbde27d6879b4f51d2ceb2a9f06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a91e8cfbde27d6879b4f51d2ceb2a9f06">rewindDirectory</a> ()</td></tr>

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

  115. <tr class="memitem:a773ee6f661fc689a5187f51cb5498086"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a773ee6f661fc689a5187f51cb5498086">seek</a> (PosType pos)</td></tr>

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

  117. <tr class="memitem:a5813d451e7f7ba57a04d177caffc5a9f"><td class="memItemLeft" align="right" valign="top">PosType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a> ()</td></tr>

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

  119. <tr class="memitem:a0ace3aaaf6d0fb673a43059c0664fab6"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a0ace3aaaf6d0fb673a43059c0664fab6">write</a> (const uint8_t *buffer, size_t <a class="el" href="class_stream_file.html#a5813d451e7f7ba57a04d177caffc5a9f">size</a>)</td></tr>

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

  121. <tr class="memitem:a0695220134825199b39dee82f18ab1ec"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write</a> (uint8_t b)</td></tr>

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

  123. </table>

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

  125. <div class="textblock"><h3>template&lt;class BaseFile, typename PosType&gt;<br />

  126. class StreamFile&lt; BaseFile, PosType &gt;</h3>

  127. 

  128. <p><a class="el" href="class_stream_file.html" title="StreamFile class.">StreamFile</a> class. </p>

  129. </div><h2 class="groupheader">Member Function Documentation</h2>

  130. <a id="a0112cc39b64aac6f1ec47741397a7582"></a>

  131. <h2 class="memtitle"><span class="permalink"><a href="#a0112cc39b64aac6f1ec47741397a7582">&#9670;&nbsp;</a></span>available()</h2>

  132. 

  133. <div class="memitem">

  134. <div class="memproto">

  135. <div class="memtemplate">

  136. template&lt;class BaseFile, typename PosType&gt; </div>

  137. <table class="mlabels">

  138.   <tr>

  139.   <td class="mlabels-left">

  140.       <table class="memname">

  141.         <tr>

  142.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::available </td>

  143.           <td>(</td>

  144.           <td class="paramname"></td><td>)</td>

  145.           <td></td>

  146.         </tr>

  147.       </table>

  148.   </td>

  149.   <td class="mlabels-right">

  150. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  151.   </tr>

  152. </table>

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

  154. <dl class="section return"><dt>Returns</dt><dd>number of bytes available from the current position to EOF or INT_MAX if more than INT_MAX bytes are available. </dd></dl>

  155. 

  156. </div>

  157. </div>

  158. <a id="a32f813e659414892a58aa5157fe14f82"></a>

  159. <h2 class="memtitle"><span class="permalink"><a href="#a32f813e659414892a58aa5157fe14f82">&#9670;&nbsp;</a></span>flush()</h2>

  160. 

  161. <div class="memitem">

  162. <div class="memproto">

  163. <div class="memtemplate">

  164. template&lt;class BaseFile, typename PosType&gt; </div>

  165. <table class="mlabels">

  166.   <tr>

  167.   <td class="mlabels-left">

  168.       <table class="memname">

  169.         <tr>

  170.           <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::flush </td>

  171.           <td>(</td>

  172.           <td class="paramname"></td><td>)</td>

  173.           <td></td>

  174.         </tr>

  175.       </table>

  176.   </td>

  177.   <td class="mlabels-right">

  178. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  179.   </tr>

  180. </table>

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

  182. <p>Ensure that any bytes written to the file are saved to the SD card. </p>

  183. 

  184. </div>

  185. </div>

  186. <a id="a586ad44055eca4c1b2b457299b829d44"></a>

  187. <h2 class="memtitle"><span class="permalink"><a href="#a586ad44055eca4c1b2b457299b829d44">&#9670;&nbsp;</a></span>isDirectory()</h2>

  188. 

  189. <div class="memitem">

  190. <div class="memproto">

  191. <div class="memtemplate">

  192. template&lt;class BaseFile, typename PosType&gt; </div>

  193. <table class="mlabels">

  194.   <tr>

  195.   <td class="mlabels-left">

  196.       <table class="memname">

  197.         <tr>

  198.           <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::isDirectory </td>

  199.           <td>(</td>

  200.           <td class="paramname"></td><td>)</td>

  201.           <td></td>

  202.         </tr>

  203.       </table>

  204.   </td>

  205.   <td class="mlabels-right">

  206. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  207.   </tr>

  208. </table>

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

  210. <p>This function reports if the current file is a directory or not. </p><dl class="section return"><dt>Returns</dt><dd>true if the file is a directory. </dd></dl>

  211. 

  212. </div>

  213. </div>

  214. <a id="a8792c863080576eb65ce6cacbe1dd931"></a>

  215. <h2 class="memtitle"><span class="permalink"><a href="#a8792c863080576eb65ce6cacbe1dd931">&#9670;&nbsp;</a></span>name()</h2>

  216. 

  217. <div class="memitem">

  218. <div class="memproto">

  219. <div class="memtemplate">

  220. template&lt;class BaseFile, typename PosType&gt; </div>

  221. <table class="mlabels">

  222.   <tr>

  223.   <td class="mlabels-left">

  224.       <table class="memname">

  225.         <tr>

  226.           <td class="memname">const char* <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::name </td>

  227.           <td>(</td>

  228.           <td class="paramname"></td><td>)</td>

  229.           <td> const</td>

  230.         </tr>

  231.       </table>

  232.   </td>

  233.   <td class="mlabels-right">

  234. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  235.   </tr>

  236. </table>

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

  238. <p>No longer implemented due to Long File Names.</p>

  239. <p>Use getName(char* name, size_t size). </p><dl class="section return"><dt>Returns</dt><dd>a pointer to replacement suggestion. </dd></dl>

  240. 

  241. </div>

  242. </div>

  243. <a id="af0da96e502485133ca0cff27fa130082"></a>

  244. <h2 class="memtitle"><span class="permalink"><a href="#af0da96e502485133ca0cff27fa130082">&#9670;&nbsp;</a></span>peek()</h2>

  245. 

  246. <div class="memitem">

  247. <div class="memproto">

  248. <div class="memtemplate">

  249. template&lt;class BaseFile, typename PosType&gt; </div>

  250. <table class="mlabels">

  251.   <tr>

  252.   <td class="mlabels-left">

  253.       <table class="memname">

  254.         <tr>

  255.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::peek </td>

  256.           <td>(</td>

  257.           <td class="paramname"></td><td>)</td>

  258.           <td></td>

  259.         </tr>

  260.       </table>

  261.   </td>

  262.   <td class="mlabels-right">

  263. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  264.   </tr>

  265. </table>

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

  267. <p>Return the next available byte without consuming it.</p>

  268. <dl class="section return"><dt>Returns</dt><dd>The byte if no error and not at eof else -1; </dd></dl>

  269. 

  270. </div>

  271. </div>

  272. <a id="a18a04d1e68a0c1e3e38e5712cd9bbc03"></a>

  273. <h2 class="memtitle"><span class="permalink"><a href="#a18a04d1e68a0c1e3e38e5712cd9bbc03">&#9670;&nbsp;</a></span>position()</h2>

  274. 

  275. <div class="memitem">

  276. <div class="memproto">

  277. <div class="memtemplate">

  278. template&lt;class BaseFile, typename PosType&gt; </div>

  279. <table class="mlabels">

  280.   <tr>

  281.   <td class="mlabels-left">

  282.       <table class="memname">

  283.         <tr>

  284.           <td class="memname">PosType <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::position </td>

  285.           <td>(</td>

  286.           <td class="paramname"></td><td>)</td>

  287.           <td></td>

  288.         </tr>

  289.       </table>

  290.   </td>

  291.   <td class="mlabels-right">

  292. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  293.   </tr>

  294. </table>

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

  296. <dl class="section return"><dt>Returns</dt><dd>the current file position. </dd></dl>

  297. 

  298. </div>

  299. </div>

  300. <a id="a249a5d428f303e2a8e7c3ae476e74829"></a>

  301. <h2 class="memtitle"><span class="permalink"><a href="#a249a5d428f303e2a8e7c3ae476e74829">&#9670;&nbsp;</a></span>read()</h2>

  302. 

  303. <div class="memitem">

  304. <div class="memproto">

  305. <div class="memtemplate">

  306. template&lt;class BaseFile, typename PosType&gt; </div>

  307. <table class="mlabels">

  308.   <tr>

  309.   <td class="mlabels-left">

  310.       <table class="memname">

  311.         <tr>

  312.           <td class="memname">int <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::read </td>

  313.           <td>(</td>

  314.           <td class="paramname"></td><td>)</td>

  315.           <td></td>

  316.         </tr>

  317.       </table>

  318.   </td>

  319.   <td class="mlabels-right">

  320. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  321.   </tr>

  322. </table>

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

  324. <p>Read the next byte from a file.</p>

  325. <dl class="section return"><dt>Returns</dt><dd>For success return the next byte in the file as an int. If an error occurs or end of file is reached return -1. </dd></dl>

  326. 

  327. </div>

  328. </div>

  329. <a id="a91e8cfbde27d6879b4f51d2ceb2a9f06"></a>

  330. <h2 class="memtitle"><span class="permalink"><a href="#a91e8cfbde27d6879b4f51d2ceb2a9f06">&#9670;&nbsp;</a></span>rewindDirectory()</h2>

  331. 

  332. <div class="memitem">

  333. <div class="memproto">

  334. <div class="memtemplate">

  335. template&lt;class BaseFile, typename PosType&gt; </div>

  336. <table class="mlabels">

  337.   <tr>

  338.   <td class="mlabels-left">

  339.       <table class="memname">

  340.         <tr>

  341.           <td class="memname">void <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::rewindDirectory </td>

  342.           <td>(</td>

  343.           <td class="paramname"></td><td>)</td>

  344.           <td></td>

  345.         </tr>

  346.       </table>

  347.   </td>

  348.   <td class="mlabels-right">

  349. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  350.   </tr>

  351. </table>

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

  353. <p>Rewind a file if it is a directory </p>

  354. 

  355. </div>

  356. </div>

  357. <a id="a773ee6f661fc689a5187f51cb5498086"></a>

  358. <h2 class="memtitle"><span class="permalink"><a href="#a773ee6f661fc689a5187f51cb5498086">&#9670;&nbsp;</a></span>seek()</h2>

  359. 

  360. <div class="memitem">

  361. <div class="memproto">

  362. <div class="memtemplate">

  363. template&lt;class BaseFile, typename PosType&gt; </div>

  364. <table class="mlabels">

  365.   <tr>

  366.   <td class="mlabels-left">

  367.       <table class="memname">

  368.         <tr>

  369.           <td class="memname">bool <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::seek </td>

  370.           <td>(</td>

  371.           <td class="paramtype">PosType&#160;</td>

  372.           <td class="paramname"><em>pos</em></td><td>)</td>

  373.           <td></td>

  374.         </tr>

  375.       </table>

  376.   </td>

  377.   <td class="mlabels-right">

  378. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  379.   </tr>

  380. </table>

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

  382. <p>Seek to a new position in the file, which must be between 0 and the size of the file (inclusive).</p>

  383. <dl class="params"><dt>Parameters</dt><dd>

  384.   <table class="params">

  385.     <tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>the new file position. </td></tr>

  386.   </table>

  387.   </dd>

  388. </dl>

  389. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  390. 

  391. </div>

  392. </div>

  393. <a id="a5813d451e7f7ba57a04d177caffc5a9f"></a>

  394. <h2 class="memtitle"><span class="permalink"><a href="#a5813d451e7f7ba57a04d177caffc5a9f">&#9670;&nbsp;</a></span>size()</h2>

  395. 

  396. <div class="memitem">

  397. <div class="memproto">

  398. <div class="memtemplate">

  399. template&lt;class BaseFile, typename PosType&gt; </div>

  400. <table class="mlabels">

  401.   <tr>

  402.   <td class="mlabels-left">

  403.       <table class="memname">

  404.         <tr>

  405.           <td class="memname">PosType <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::size </td>

  406.           <td>(</td>

  407.           <td class="paramname"></td><td>)</td>

  408.           <td></td>

  409.         </tr>

  410.       </table>

  411.   </td>

  412.   <td class="mlabels-right">

  413. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  414.   </tr>

  415. </table>

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

  417. <dl class="section return"><dt>Returns</dt><dd>the file's size. </dd></dl>

  418. 

  419. </div>

  420. </div>

  421. <a id="a0ace3aaaf6d0fb673a43059c0664fab6"></a>

  422. <h2 class="memtitle"><span class="permalink"><a href="#a0ace3aaaf6d0fb673a43059c0664fab6">&#9670;&nbsp;</a></span>write() <span class="overload">[1/2]</span></h2>

  423. 

  424. <div class="memitem">

  425. <div class="memproto">

  426. <div class="memtemplate">

  427. template&lt;class BaseFile, typename PosType&gt; </div>

  428. <table class="mlabels">

  429.   <tr>

  430.   <td class="mlabels-left">

  431.       <table class="memname">

  432.         <tr>

  433.           <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::write </td>

  434.           <td>(</td>

  435.           <td class="paramtype">const uint8_t *&#160;</td>

  436.           <td class="paramname"><em>buffer</em>, </td>

  437.         </tr>

  438.         <tr>

  439.           <td class="paramkey"></td>

  440.           <td></td>

  441.           <td class="paramtype">size_t&#160;</td>

  442.           <td class="paramname"><em>size</em>&#160;</td>

  443.         </tr>

  444.         <tr>

  445.           <td></td>

  446.           <td>)</td>

  447.           <td></td><td></td>

  448.         </tr>

  449.       </table>

  450.   </td>

  451.   <td class="mlabels-right">

  452. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  453.   </tr>

  454. </table>

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

  456. <p>Write data to an open file.</p>

  457. <dl class="section note"><dt>Note</dt><dd>Data is moved to the cache but may not be written to the storage device until sync() is called.</dd></dl>

  458. <dl class="params"><dt>Parameters</dt><dd>

  459.   <table class="params">

  460.     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Pointer to the location of the data to be written.</td></tr>

  461.     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes to write.</td></tr>

  462.   </table>

  463.   </dd>

  464. </dl>

  465. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_stream_file.html#a0695220134825199b39dee82f18ab1ec">write()</a> returns the number of bytes written, always <em>size</em>. </dd></dl>

  466. 

  467. </div>

  468. </div>

  469. <a id="a0695220134825199b39dee82f18ab1ec"></a>

  470. <h2 class="memtitle"><span class="permalink"><a href="#a0695220134825199b39dee82f18ab1ec">&#9670;&nbsp;</a></span>write() <span class="overload">[2/2]</span></h2>

  471. 

  472. <div class="memitem">

  473. <div class="memproto">

  474. <div class="memtemplate">

  475. template&lt;class BaseFile, typename PosType&gt; </div>

  476. <table class="mlabels">

  477.   <tr>

  478.   <td class="mlabels-left">

  479.       <table class="memname">

  480.         <tr>

  481.           <td class="memname">size_t <a class="el" href="class_stream_file.html">StreamFile</a>&lt; BaseFile, PosType &gt;::write </td>

  482.           <td>(</td>

  483.           <td class="paramtype">uint8_t&#160;</td>

  484.           <td class="paramname"><em>b</em></td><td>)</td>

  485.           <td></td>

  486.         </tr>

  487.       </table>

  488.   </td>

  489.   <td class="mlabels-right">

  490. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  491.   </tr>

  492. </table>

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

  494. <p>Write a byte to a file. Required by the Arduino Print class. </p><dl class="params"><dt>Parameters</dt><dd>

  495.   <table class="params">

  496.     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>the byte to be written. Use getWriteError to check for errors. </td></tr>

  497.   </table>

  498.   </dd>

  499. </dl>

  500. <dl class="section return"><dt>Returns</dt><dd>1 for success and 0 for failure. </dd></dl>

  501. 

  502. </div>

  503. </div>

  504. <hr/>The documentation for this class was generated from the following file:<ul>

  505. <li>ArduinoSdFat/libraries/SdFat/src/common/ArduinoFiles.h</li>

  506. </ul>

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

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

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

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

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

  512. </a> 1.8.16

  513. </small></address>

  514. </body>

  515. </html>