visus
/
teensy-sdfat
Следить 1
В избранное 0
Форкнуть 0
Код Задачи 0 Pull Request'ы 0 Релизы 0 Вики Активность
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
50 коммитов
1 ветка
Дерево: 407591b05b
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из '407591b05b'
${ noResults }
teensy-sdfat/extras/html/class_stream_file.html

510 lines
22KB
Исходник Blame История 

  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: 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.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. 

  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. </map>

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

  83. <div class="dynheader">

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

  85. <div class="dyncontent">

  86. <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>

  87. <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">

  88. </map>

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

  90. <table class="memberdecls">

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

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

  93. <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>

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

  95. <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>

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

  97. <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>

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

  99. <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>

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

  101. <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>

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

  103. <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>

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

  105. <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>

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

  107. <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>

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

  109. <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>

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

  111. <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>

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

  113. <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>

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

  115. <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>

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

  117. </table>

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

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

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

  121. 

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

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

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

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

  126. 

  127. <div class="memitem">

  128. <div class="memproto">

  129. <div class="memtemplate">

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

  131. <table class="mlabels">

  132.   <tr>

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

  134.       <table class="memname">

  135.         <tr>

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

  137.           <td>(</td>

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

  139.           <td></td>

  140.         </tr>

  141.       </table>

  142.   </td>

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

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

  145.   </tr>

  146. </table>

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

  148. <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>

  149. 

  150. </div>

  151. </div>

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

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

  154. 

  155. <div class="memitem">

  156. <div class="memproto">

  157. <div class="memtemplate">

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

  159. <table class="mlabels">

  160.   <tr>

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

  162.       <table class="memname">

  163.         <tr>

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

  165.           <td>(</td>

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

  167.           <td></td>

  168.         </tr>

  169.       </table>

  170.   </td>

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

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

  173.   </tr>

  174. </table>

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

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

  177. 

  178. </div>

  179. </div>

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

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

  182. 

  183. <div class="memitem">

  184. <div class="memproto">

  185. <div class="memtemplate">

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

  187. <table class="mlabels">

  188.   <tr>

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

  190.       <table class="memname">

  191.         <tr>

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

  193.           <td>(</td>

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

  195.           <td></td>

  196.         </tr>

  197.       </table>

  198.   </td>

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

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

  201.   </tr>

  202. </table>

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

  204. <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>

  205. 

  206. </div>

  207. </div>

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

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

  210. 

  211. <div class="memitem">

  212. <div class="memproto">

  213. <div class="memtemplate">

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

  215. <table class="mlabels">

  216.   <tr>

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

  218.       <table class="memname">

  219.         <tr>

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

  221.           <td>(</td>

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

  223.           <td> const</td>

  224.         </tr>

  225.       </table>

  226.   </td>

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

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

  229.   </tr>

  230. </table>

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

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

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

  234. 

  235. </div>

  236. </div>

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

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

  239. 

  240. <div class="memitem">

  241. <div class="memproto">

  242. <div class="memtemplate">

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

  244. <table class="mlabels">

  245.   <tr>

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

  247.       <table class="memname">

  248.         <tr>

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

  250.           <td>(</td>

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

  252.           <td></td>

  253.         </tr>

  254.       </table>

  255.   </td>

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

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

  258.   </tr>

  259. </table>

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

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

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

  263. 

  264. </div>

  265. </div>

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

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

  268. 

  269. <div class="memitem">

  270. <div class="memproto">

  271. <div class="memtemplate">

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

  273. <table class="mlabels">

  274.   <tr>

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

  276.       <table class="memname">

  277.         <tr>

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

  279.           <td>(</td>

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

  281.           <td></td>

  282.         </tr>

  283.       </table>

  284.   </td>

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

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

  287.   </tr>

  288. </table>

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

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

  291. 

  292. </div>

  293. </div>

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

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

  296. 

  297. <div class="memitem">

  298. <div class="memproto">

  299. <div class="memtemplate">

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

  301. <table class="mlabels">

  302.   <tr>

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

  304.       <table class="memname">

  305.         <tr>

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

  307.           <td>(</td>

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

  309.           <td></td>

  310.         </tr>

  311.       </table>

  312.   </td>

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

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

  315.   </tr>

  316. </table>

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

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

  319. <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>

  320. 

  321. </div>

  322. </div>

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

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

  325. 

  326. <div class="memitem">

  327. <div class="memproto">

  328. <div class="memtemplate">

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

  330. <table class="mlabels">

  331.   <tr>

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

  333.       <table class="memname">

  334.         <tr>

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

  336.           <td>(</td>

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

  338.           <td></td>

  339.         </tr>

  340.       </table>

  341.   </td>

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

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

  344.   </tr>

  345. </table>

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

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

  348. 

  349. </div>

  350. </div>

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

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

  353. 

  354. <div class="memitem">

  355. <div class="memproto">

  356. <div class="memtemplate">

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

  358. <table class="mlabels">

  359.   <tr>

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

  361.       <table class="memname">

  362.         <tr>

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

  364.           <td>(</td>

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

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

  367.           <td></td>

  368.         </tr>

  369.       </table>

  370.   </td>

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

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

  373.   </tr>

  374. </table>

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

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

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

  378.   <table class="params">

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

  380.   </table>

  381.   </dd>

  382. </dl>

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

  384. 

  385. </div>

  386. </div>

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

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

  389. 

  390. <div class="memitem">

  391. <div class="memproto">

  392. <div class="memtemplate">

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

  394. <table class="mlabels">

  395.   <tr>

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

  397.       <table class="memname">

  398.         <tr>

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

  400.           <td>(</td>

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

  402.           <td></td>

  403.         </tr>

  404.       </table>

  405.   </td>

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

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

  408.   </tr>

  409. </table>

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

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

  412. 

  413. </div>

  414. </div>

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

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

  417. 

  418. <div class="memitem">

  419. <div class="memproto">

  420. <div class="memtemplate">

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

  422. <table class="mlabels">

  423.   <tr>

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

  425.       <table class="memname">

  426.         <tr>

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

  428.           <td>(</td>

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

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

  431.           <td></td>

  432.         </tr>

  433.       </table>

  434.   </td>

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

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

  437.   </tr>

  438. </table>

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

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

  441.   <table class="params">

  442.     <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>

  443.   </table>

  444.   </dd>

  445. </dl>

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

  447. 

  448. </div>

  449. </div>

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

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

  452. 

  453. <div class="memitem">

  454. <div class="memproto">

  455. <div class="memtemplate">

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

  457. <table class="mlabels">

  458.   <tr>

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

  460.       <table class="memname">

  461.         <tr>

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

  463.           <td>(</td>

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

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

  466.         </tr>

  467.         <tr>

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

  469.           <td></td>

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

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

  472.         </tr>

  473.         <tr>

  474.           <td></td>

  475.           <td>)</td>

  476.           <td></td><td></td>

  477.         </tr>

  478.       </table>

  479.   </td>

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

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

  482.   </tr>

  483. </table>

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

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

  486. <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>

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

  488.   <table class="params">

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

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

  491.   </table>

  492.   </dd>

  493. </dl>

  494. <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>

  495. 

  496. </div>

  497. </div>

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

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

  500. </ul>

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

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

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

  504. Generated on Thu May 9 2019 06:51:29 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  506. </a> 1.8.14

  507. </small></address>

  508. </body>

  509. </html>