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.
9 Commits
1 Branch
Tree: 940b09a7dd
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '940b09a7dd'
${ noResults }
teensy-sdfat/html/_stdio_stream_8h.html

209 lines
12KB
Raw Blame History 

  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.8"/>

  7. <title>SdFat: Arduino/libraries/SdFat/StdioStream.h File 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="doxygen.css" rel="stylesheet" type="text/css" />

  12. </head>

  13. <body>

  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  15. <div id="titlearea">

  16. <table cellspacing="0" cellpadding="0">

  17.  <tbody>

  18.  <tr style="height: 56px;">

  19.   <td style="padding-left: 0.5em;">

  20.    <div id="projectname">SdFat

  21.    </div>

  22.   </td>

  23.  </tr>

  24.  </tbody>

  25. </table>

  26. </div>

  27. <!-- end header part -->

  28. <!-- Generated by Doxygen 1.8.8 -->

  29.   <div id="navrow1" class="tabs">

  30.     <ul class="tablist">

  31.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  32.       <li><a href="annotated.html"><span>Classes</span></a></li>

  33.       <li class="current"><a href="files.html"><span>Files</span></a></li>

  34.     </ul>

  35.   </div>

  36.   <div id="navrow2" class="tabs2">

  37.     <ul class="tablist">

  38.       <li><a href="files.html"><span>File&#160;List</span></a></li>

  39.       <li><a href="globals.html"><span>File&#160;Members</span></a></li>

  40.     </ul>

  41.   </div>

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

  43.   <ul>

  44. <li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li><li class="navelem"><a class="el" href="dir_1281b15c327061056ab3b326e90c50cf.html">SdFat</a></li>  </ul>

  45. </div>

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

  47. <div class="header">

  48.   <div class="summary">

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

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

  51. <a href="#var-members">Variables</a>  </div>

  52.   <div class="headertitle">

  53. <div class="title">StdioStream.h File Reference</div>  </div>

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

  55. <div class="contents">

  56. 

  57. <p><a class="el" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. ">StdioStream</a> class.  

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

  59. <div class="textblock"><code>#include &lt;limits.h&gt;</code><br />

  60. <code>#include &lt;Arduino.h&gt;</code><br />

  61. <code>#include &lt;<a class="el" href="_sd_fat_8h.html">SdFat.h</a>&gt;</code><br />

  62. <code>#include &lt;<a class="el" href="_sd_base_file_8h.html">SdBaseFile.h</a>&gt;</code><br />

  63. <code>#include &lt;stdio.h&gt;</code><br />

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

  65. Include dependency graph for StdioStream.h:</div>

  66. <div class="dyncontent">

  67. <div class="center"><img src="_stdio_stream_8h__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_stdio_stream_8h" alt=""/></div>

  68. <map name="_arduino_2libraries_2_sd_fat_2_stdio_stream_8h" id="_arduino_2libraries_2_sd_fat_2_stdio_stream_8h">

  69. <area shape="rect" id="node7" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="422,96,489,123"/>
<area shape="rect" id="node12" href="_sd_base_file_8h.html" title="SdBaseFile class. " alt="" coords="287,544,387,571"/>
<area shape="rect" id="node9" href="_sd_file_8h.html" title="SdFile class. " alt="" coords="222,171,292,197"/>
<area shape="rect" id="node36" href="_sd_stream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="296,245,387,272"/>
<area shape="rect" id="node50" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="397,171,515,197"/>
<area shape="rect" id="node15" href="_sd_fat_config_8h.html" title="configuration definitions " alt="" coords="5,843,109,869"/>
<area shape="rect" id="node19" href="_sd_volume_8h.html" title="SdVolume class. " alt="" coords="153,619,247,645"/>
<area shape="rect" id="node22" href="_sd2_card_8h.html" title="Sd2Card class for V2 SD/SDHC cards. " alt="" coords="224,693,307,720"/>
<area shape="rect" id="node28" href="_sd_spi_8h.html" title="SdSpi class for V2 SD/SDHC cards. " alt="" coords="121,768,188,795"/>
<area shape="rect" id="node39" href="iostream_8h.html" title="iostream class " alt="" coords="377,320,460,347"/>
<area shape="rect" id="node41" href="istream_8h.html" title="istream class " alt="" coords="446,395,521,421"/>
<area shape="rect" id="node46" href="ostream_8h.html" title="ostream class " alt="" coords="341,395,421,421"/>
<area shape="rect" id="node43" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="356,469,407,496"/>
<area shape="rect" id="node52" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="411,245,501,272"/>
</map>

  70. </div>

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

  72. This graph shows which files directly or indirectly include this file:</div>

  73. <div class="dyncontent">

  74. <div class="center"><img src="_stdio_stream_8h__dep__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_stdio_stream_8hdep" alt=""/></div>

  75. <map name="_arduino_2libraries_2_sd_fat_2_stdio_stream_8hdep" id="_arduino_2libraries_2_sd_fat_2_stdio_stream_8hdep">

  76. <area shape="rect" id="node3" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="5,97,160,138"/>
<area shape="rect" id="node5" href="_sd_fat_util_8h.html" title="Useful utility functions. " alt="" coords="5,187,160,229"/>
</map>

  77. </div>

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

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

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

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

  82. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. ">StdioStream</a> implements a minimal stdio stream.  <a href="class_stdio_stream.html#details">More...</a><br /></td></tr>

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

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

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

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

  87. <tr class="memitem:a59adc4c82490d23754cd39c2fb99b0da"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a59adc4c82490d23754cd39c2fb99b0da">EOF</a>&#160;&#160;&#160;(-1)</td></tr>

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

  89. <tr class="memitem:a070d2ce7b6bb7e5c05602aa8c308d0c4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>&#160;&#160;&#160;0</td></tr>

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

  91. <tr class="memitem:a4c8d0b76b470ba65a43ca46a88320f39"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a4c8d0b76b470ba65a43ca46a88320f39">SEEK_CUR</a>&#160;&#160;&#160;1</td></tr>

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

  93. <tr class="memitem:ad2a2e6c114780c3071efd24f16c7f7d8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#ad2a2e6c114780c3071efd24f16c7f7d8">SEEK_END</a>&#160;&#160;&#160;2</td></tr>

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

  95. <tr class="memitem:a0d112bae8fd35be772185b6ec6bcbe64"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a0d112bae8fd35be772185b6ec6bcbe64">SEEK_SET</a>&#160;&#160;&#160;0</td></tr>

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

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

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

  99. Variables</h2></td></tr>

  100. <tr class="memitem:ad9a6150ef11e2616c1a99bc777df17d3"><td class="memItemLeft" align="right" valign="top">const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#ad9a6150ef11e2616c1a99bc777df17d3">STREAM_BUF_SIZE</a> = 64</td></tr>

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

  102. <tr class="memitem:a785dd413c0d7b05f95df82d3453ecacd"><td class="memItemLeft" align="right" valign="top">const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a785dd413c0d7b05f95df82d3453ecacd">UNGETC_BUF_SIZE</a> = 2</td></tr>

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

  104. </table>

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

  106. <div class="textblock"><p><a class="el" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. ">StdioStream</a> class. </p>

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

  108. <a class="anchor" id="a59adc4c82490d23754cd39c2fb99b0da"></a>

  109. <div class="memitem">

  110. <div class="memproto">

  111.       <table class="memname">

  112.         <tr>

  113.           <td class="memname">#define EOF&#160;&#160;&#160;(-1)</td>

  114.         </tr>

  115.       </table>

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

  117. <p>End-of-file return value. </p>

  118. 

  119. </div>

  120. </div>

  121. <a class="anchor" id="a070d2ce7b6bb7e5c05602aa8c308d0c4"></a>

  122. <div class="memitem">

  123. <div class="memproto">

  124.       <table class="memname">

  125.         <tr>

  126.           <td class="memname">#define NULL&#160;&#160;&#160;0</td>

  127.         </tr>

  128.       </table>

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

  130. <p>Null pointer </p>

  131. 

  132. </div>

  133. </div>

  134. <a class="anchor" id="a4c8d0b76b470ba65a43ca46a88320f39"></a>

  135. <div class="memitem">

  136. <div class="memproto">

  137.       <table class="memname">

  138.         <tr>

  139.           <td class="memname">#define SEEK_CUR&#160;&#160;&#160;1</td>

  140.         </tr>

  141.       </table>

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

  143. <p>Seek relative to current position. </p>

  144. 

  145. </div>

  146. </div>

  147. <a class="anchor" id="ad2a2e6c114780c3071efd24f16c7f7d8"></a>

  148. <div class="memitem">

  149. <div class="memproto">

  150.       <table class="memname">

  151.         <tr>

  152.           <td class="memname">#define SEEK_END&#160;&#160;&#160;2</td>

  153.         </tr>

  154.       </table>

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

  156. <p>Seek relative to end-of-file. </p>

  157. 

  158. </div>

  159. </div>

  160. <a class="anchor" id="a0d112bae8fd35be772185b6ec6bcbe64"></a>

  161. <div class="memitem">

  162. <div class="memproto">

  163.       <table class="memname">

  164.         <tr>

  165.           <td class="memname">#define SEEK_SET&#160;&#160;&#160;0</td>

  166.         </tr>

  167.       </table>

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

  169. <p>Seek relative to start-of-file. </p>

  170. 

  171. </div>

  172. </div>

  173. <h2 class="groupheader">Variable Documentation</h2>

  174. <a class="anchor" id="ad9a6150ef11e2616c1a99bc777df17d3"></a>

  175. <div class="memitem">

  176. <div class="memproto">

  177.       <table class="memname">

  178.         <tr>

  179.           <td class="memname">const uint8_t STREAM_BUF_SIZE = 64</td>

  180.         </tr>

  181.       </table>

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

  183. <p>Total size of stream buffer. The entire buffer is used for output. During input UNGETC_BUF_SIZE of this space is reserved for ungetc. </p>

  184. 

  185. </div>

  186. </div>

  187. <a class="anchor" id="a785dd413c0d7b05f95df82d3453ecacd"></a>

  188. <div class="memitem">

  189. <div class="memproto">

  190.       <table class="memname">

  191.         <tr>

  192.           <td class="memname">const uint8_t UNGETC_BUF_SIZE = 2</td>

  193.         </tr>

  194.       </table>

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

  196. <p>Amount of buffer allocated for ungetc during input. </p>

  197. 

  198. </div>

  199. </div>

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

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

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

  203. Generated on Sat Oct 25 2014 07:56:22 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  205. </a> 1.8.8

  206. </small></address>

  207. </body>

  208. </html>