forked from greiman/SdFat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_stdio_stream_8h.html
222 lines (215 loc) · 12 KB
/
_stdio_stream_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>SdFat: Arduino/libraries/SdFat/StdioStream.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SdFat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">StdioStream.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <limits.h></code><br/>
<code>#include <Arduino.h></code><br/>
<code>#include <<a class="el" href="_sd_fat_8h.html">SdFat.h</a>></code><br/>
<code>#include <<a class="el" href="_sd_base_file_8h.html">SdBaseFile.h</a>></code><br/>
<code>#include <stdio.h></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for StdioStream.h:</div>
<div class="dyncontent">
<div class="center"><img src="_stdio_stream_8h__incl.png" border="0" usemap="#_arduino_2libraries_2_sd_fat_2_stdio_stream_8h" alt=""/></div>
<map name="_arduino_2libraries_2_sd_fat_2_stdio_stream_8h" id="_arduino_2libraries_2_sd_fat_2_stdio_stream_8h">
<area shape="rect" id="node7" href="_sd_fat_8h.html" title="SdFat class. " alt="" coords="417,96,484,123"/><area shape="rect" id="node11" href="_sd_base_file_8h.html" title="SdBaseFile class. " alt="" coords="319,544,419,571"/><area shape="rect" id="node9" href="_sd_file_8h.html" title="SdFile class. " alt="" coords="146,320,216,347"/><area shape="rect" id="node35" href="_sd_stream_8h.html" title="fstream, ifstream, and ofstream classes " alt="" coords="400,245,491,272"/><area shape="rect" id="node48" href="_arduino_stream_8h.html" title="ArduinoInStream and ArduinoOutStream classes. " alt="" coords="210,171,328,197"/><area shape="rect" id="node53" href="_minimum_serial_8h.html" title="MinimumSerial.h" alt="" coords="353,171,471,197"/><area shape="rect" id="node14" href="_sd_fat_config_8h.html" title="configuration definitions " alt="" coords="5,843,109,869"/><area shape="rect" id="node18" href="_sd_volume_8h.html" title="SdVolume class. " alt="" coords="153,619,247,645"/><area shape="rect" id="node21" href="_sd2_card_8h.html" title="Sd2Card class for V2 SD/SDHC cards. " alt="" coords="224,693,307,720"/><area shape="rect" id="node27" href="_sd_spi_8h.html" title="SdSpi class for V2 SD/SDHC cards. " alt="" coords="121,768,188,795"/><area shape="rect" id="node38" href="iostream_8h.html" title="iostream class " alt="" coords="297,320,380,347"/><area shape="rect" id="node40" href="istream_8h.html" title="istream class " alt="" coords="227,395,303,421"/><area shape="rect" id="node45" href="ostream_8h.html" title="ostream class " alt="" coords="328,395,408,421"/><area shape="rect" id="node42" href="ios_8h.html" title="ios_base and ios classes " alt="" coords="343,469,393,496"/><area shape="rect" id="node50" href="bufstream_8h.html" title="ibufstream and obufstream classes " alt="" coords="264,245,355,272"/></map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<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>
<map name="_arduino_2libraries_2_sd_fat_2_stdio_stream_8hdep" id="_arduino_2libraries_2_sd_fat_2_stdio_stream_8hdep">
<area shape="rect" id="node3" href="_stdio_stream_8cpp.html" title="Arduino/libraries/SdFat\l/StdioStream.cpp" alt="" coords="5,97,160,138"/></map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stdio_stream.html">StdioStream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </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>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a59adc4c82490d23754cd39c2fb99b0da"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a59adc4c82490d23754cd39c2fb99b0da">EOF</a>   (-1)</td></tr>
<tr class="separator:a59adc4c82490d23754cd39c2fb99b0da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a070d2ce7b6bb7e5c05602aa8c308d0c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>   0</td></tr>
<tr class="separator:a070d2ce7b6bb7e5c05602aa8c308d0c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c8d0b76b470ba65a43ca46a88320f39"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a4c8d0b76b470ba65a43ca46a88320f39">SEEK_CUR</a>   1</td></tr>
<tr class="separator:a4c8d0b76b470ba65a43ca46a88320f39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2a2e6c114780c3071efd24f16c7f7d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#ad2a2e6c114780c3071efd24f16c7f7d8">SEEK_END</a>   2</td></tr>
<tr class="separator:ad2a2e6c114780c3071efd24f16c7f7d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d112bae8fd35be772185b6ec6bcbe64"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a0d112bae8fd35be772185b6ec6bcbe64">SEEK_SET</a>   0</td></tr>
<tr class="separator:a0d112bae8fd35be772185b6ec6bcbe64"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ad9a6150ef11e2616c1a99bc777df17d3"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#ad9a6150ef11e2616c1a99bc777df17d3">STREAM_BUF_SIZE</a> = 64</td></tr>
<tr class="separator:ad9a6150ef11e2616c1a99bc777df17d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a785dd413c0d7b05f95df82d3453ecacd"><td class="memItemLeft" align="right" valign="top">const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_stdio_stream_8h.html#a785dd413c0d7b05f95df82d3453ecacd">UNGETC_BUF_SIZE</a> = 2</td></tr>
<tr class="separator:a785dd413c0d7b05f95df82d3453ecacd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_stdio_stream.html" title="StdioStream implements a minimal stdio stream. ">StdioStream</a> class </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a59adc4c82490d23754cd39c2fb99b0da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EOF   (-1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>End-of-file return value. </p>
</div>
</div>
<a class="anchor" id="a070d2ce7b6bb7e5c05602aa8c308d0c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NULL   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Null pointer </p>
</div>
</div>
<a class="anchor" id="a4c8d0b76b470ba65a43ca46a88320f39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SEEK_CUR   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Seek relative to current position. </p>
</div>
</div>
<a class="anchor" id="ad2a2e6c114780c3071efd24f16c7f7d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SEEK_END   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Seek relative to end-of-file. </p>
</div>
</div>
<a class="anchor" id="a0d112bae8fd35be772185b6ec6bcbe64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SEEK_SET   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Seek relative to start-of-file. </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="ad9a6150ef11e2616c1a99bc777df17d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t STREAM_BUF_SIZE = 64</td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a785dd413c0d7b05f95df82d3453ecacd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t UNGETC_BUF_SIZE = 2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Amount of buffer allocated for ungetc during input. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 5 2014 09:13:28 for SdFat by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>