gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/stdio_8h.html
1 <!-- HTML header for doxygen 1.8.14-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="cache-control" content="max-age=86400"/>
6 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
8 <meta name="generator" content="Doxygen 1.9.2"/>
9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
10 <title>GBDK 2020 Docs: gbdk-lib/include/stdio.h File Reference</title>
11 <link href="tabs.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="jquery.js"></script>
13 <script type="text/javascript" src="dynsections.js"></script>
14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
15 <script type="text/javascript" src="resize.js"></script>
16 <script type="text/javascript" src="navtreedata.js"></script>
17 <script type="text/javascript" src="navtree.js"></script>
18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="search/searchdata.js"></script>
20 <script type="text/javascript" src="search/search.js"></script>
21 <link href="doxygen.css" rel="stylesheet" type="text/css" />
22 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25 <!-- BEGIN: doxygen-awesome-css -->
26 <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
27 <script type="text/javascript">
28 DoxygenAwesomeDarkModeToggle.init()
29 </script>
30 <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
31 <script type="text/javascript">
32 DoxygenAwesomeParagraphLink.init()
33 </script>
34 <!-- END: doxygen-awesome-css -->
35 </head>
36 <body>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <div id="titlearea">
39 <table cellspacing="0" cellpadding="0">
40 <tbody>
41 <tr style="height: 56px;">
42 <td id="projectalign" style="padding-left: 0.5em;">
43 <div id="projectname">GBDK 2020 Docs
44  <span id="projectnumber">4.5.0</span>
45 </div>
46 <div id="projectbrief">API Documentation for GBDK 2020</div>
47 </td>
48 </tr>
49 </tbody>
50 </table>
51 </div>
52 <!-- end header part -->
53 <!-- Generated by Doxygen 1.9.2 -->
54 <script type="text/javascript">
55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
57 /* @license-end */
58 </script>
59 <script type="text/javascript" src="menudata.js"></script>
60 <script type="text/javascript" src="menu.js"></script>
61 <script type="text/javascript">
62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
63 $(function() {
64 initMenu('',true,false,'search.php','Search');
65 $(document).ready(function() { init_search(); });
66 });
67 /* @license-end */
68 </script>
69 <div id="main-nav"></div>
70 </div><!-- top -->
71 <div id="side-nav" class="ui-resizable side-nav-resizable">
72 <div id="nav-tree">
73 <div id="nav-tree-contents">
74 <div id="nav-sync" class="sync"></div>
75 </div>
76 </div>
77 <div id="splitbar" style="-moz-user-select:none;"
78 class="ui-resizable-handle">
79 </div>
80 </div>
81 <script type="text/javascript">
82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
83 $(document).ready(function(){initNavTree('stdio_8h.html',''); initResizable(); });
84 /* @license-end */
85 </script>
86 <div id="doc-content">
87 <!-- window showing the filter options -->
88 <div id="MSearchSelectWindow"
89 onmouseover="return searchBox.OnSearchSelectShow()"
90 onmouseout="return searchBox.OnSearchSelectHide()"
91 onkeydown="return searchBox.OnSearchSelectKey(event)">
92 </div>
93
94 <!-- iframe showing the search results (closed by default) -->
95 <div id="MSearchResultsWindow">
96 <iframe src="javascript:void(0)" frameborder="0"
97 name="MSearchResults" id="MSearchResults">
98 </iframe>
99 </div>
100
101 <div class="header">
102 <div class="summary">
103 <a href="#func-members">Functions</a> </div>
104 <div class="headertitle"><div class="title">stdio.h File Reference</div></div>
105 </div><!--header-->
106 <div class="contents">
107 <div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">types.h</a>></code><br />
108 </div>
109 <p><a href="stdio_8h_source.html">Go to the source code of this file.</a></p>
110 <table class="memberdecls">
111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
112 Functions</h2></td></tr>
113 <tr class="memitem:putchar"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#putchar">putchar</a> (char <a class="el" href="sms_8h.html#c">c</a>) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> REENTRANT</td></tr>
114 <tr class="separator:putchar"><td class="memSeparator" colspan="2"> </td></tr>
115 <tr class="memitem:printf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#printf">printf</a> (const char *format,...)</td></tr>
116 <tr class="separator:printf"><td class="memSeparator" colspan="2"> </td></tr>
117 <tr class="memitem:sprintf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#sprintf">sprintf</a> (char *str, const char *format,...)</td></tr>
118 <tr class="separator:sprintf"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="memitem:puts"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#puts">puts</a> (const char *s)</td></tr>
120 <tr class="separator:puts"><td class="memSeparator" colspan="2"> </td></tr>
121 <tr class="memitem:gets"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#gets">gets</a> (char *s) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
122 <tr class="separator:gets"><td class="memSeparator" colspan="2"> </td></tr>
123 <tr class="memitem:getchar"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#getchar">getchar</a> (void) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
124 <tr class="separator:getchar"><td class="memSeparator" colspan="2"> </td></tr>
125 </table>
126 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127 <div class="textblock"><p >Basic file/console input output functions.</p>
128 <p >Including stdio.h will use a large number of the background tiles for font characters. If stdio.h is not included then that space will be available for use with other tiles instead. </p>
129 </div><h2 class="groupheader">Function Documentation</h2>
130 <a id="putchar" name="putchar"></a>
131 <h2 class="memtitle"><span class="permalink"><a href="#putchar">◆ </a></span>putchar()</h2>
132
133 <div class="memitem">
134 <div class="memproto">
135 <table class="memname">
136 <tr>
137 <td class="memname">void putchar </td>
138 <td>(</td>
139 <td class="paramtype">char </td>
140 <td class="paramname"><em>c</em></td><td>)</td>
141 <td></td>
142 </tr>
143 </table>
144 </div><div class="memdoc">
145 <p >Print char to stdout. </p><dl class="params"><dt>Parameters</dt><dd>
146 <table class="params">
147 <tr><td class="paramname">c</td><td>Character to print </td></tr>
148 </table>
149 </dd>
150 </dl>
151
152 </div>
153 </div>
154 <a id="printf" name="printf"></a>
155 <h2 class="memtitle"><span class="permalink"><a href="#printf">◆ </a></span>printf()</h2>
156
157 <div class="memitem">
158 <div class="memproto">
159 <table class="memname">
160 <tr>
161 <td class="memname">void printf </td>
162 <td>(</td>
163 <td class="paramtype">const char * </td>
164 <td class="paramname"><em>format</em>, </td>
165 </tr>
166 <tr>
167 <td class="paramkey"></td>
168 <td></td>
169 <td class="paramtype"> </td>
170 <td class="paramname"><em>...</em> </td>
171 </tr>
172 <tr>
173 <td></td>
174 <td>)</td>
175 <td></td><td></td>
176 </tr>
177 </table>
178 </div><div class="memdoc">
179 <p >Print the string and arguments given by format to stdout.</p>
180 <dl class="params"><dt>Parameters</dt><dd>
181 <table class="params">
182 <tr><td class="paramname">format</td><td>The format string as per printf</td></tr>
183 </table>
184 </dd>
185 </dl>
186 <p>Does not return the number of characters printed.</p>
187 <p >Currently supported: </p><ul>
188 <li>%hx (char as hex) </li>
189 <li>%hu (unsigned char) </li>
190 <li>%hd (signed char) </li>
191 <li>%c (character) </li>
192 <li>%u (unsigned int) </li>
193 <li>%d (signed int) </li>
194 <li>%x (unsigned int as hex) </li>
195 <li>%s (string)</li>
196 </ul>
197 <p>Warning: to correctly pass parameters (such as chars, ints, etc) <b>all of them should always be explicitly cast</b> as when calling the function. See <a class="el" href="docs_coding_guidelines.html#docs_chars_varargs">docs_chars_varargs</a> for more details. </p>
198
199 </div>
200 </div>
201 <a id="sprintf" name="sprintf"></a>
202 <h2 class="memtitle"><span class="permalink"><a href="#sprintf">◆ </a></span>sprintf()</h2>
203
204 <div class="memitem">
205 <div class="memproto">
206 <table class="memname">
207 <tr>
208 <td class="memname">void sprintf </td>
209 <td>(</td>
210 <td class="paramtype">char * </td>
211 <td class="paramname"><em>str</em>, </td>
212 </tr>
213 <tr>
214 <td class="paramkey"></td>
215 <td></td>
216 <td class="paramtype">const char * </td>
217 <td class="paramname"><em>format</em>, </td>
218 </tr>
219 <tr>
220 <td class="paramkey"></td>
221 <td></td>
222 <td class="paramtype"> </td>
223 <td class="paramname"><em>...</em> </td>
224 </tr>
225 <tr>
226 <td></td>
227 <td>)</td>
228 <td></td><td></td>
229 </tr>
230 </table>
231 </div><div class="memdoc">
232 <p >Print the string and arguments given by format to a buffer.</p>
233 <dl class="params"><dt>Parameters</dt><dd>
234 <table class="params">
235 <tr><td class="paramname">str</td><td>The buffer to print into </td></tr>
236 <tr><td class="paramname">format</td><td>The format string as per <a class="el" href="stdio_8h.html#printf">printf</a></td></tr>
237 </table>
238 </dd>
239 </dl>
240 <p>Does not return the number of characters printed.</p>
241 <p >Warning: to correctly pass parameters (such as chars, ints, etc) <b>all of them should always be explicitly cast</b> as when calling the function. See <a class="el" href="docs_coding_guidelines.html#docs_chars_varargs">docs_chars_varargs</a> for more details. </p>
242
243 </div>
244 </div>
245 <a id="puts" name="puts"></a>
246 <h2 class="memtitle"><span class="permalink"><a href="#puts">◆ </a></span>puts()</h2>
247
248 <div class="memitem">
249 <div class="memproto">
250 <table class="memname">
251 <tr>
252 <td class="memname">void puts </td>
253 <td>(</td>
254 <td class="paramtype">const char * </td>
255 <td class="paramname"><em>s</em></td><td>)</td>
256 <td></td>
257 </tr>
258 </table>
259 </div><div class="memdoc">
260 <p ><a class="el" href="stdio_8h.html#puts">puts()</a> writes the string <b>s</b> and a trailing newline to stdout. </p>
261
262 </div>
263 </div>
264 <a id="gets" name="gets"></a>
265 <h2 class="memtitle"><span class="permalink"><a href="#gets">◆ </a></span>gets()</h2>
266
267 <div class="memitem">
268 <div class="memproto">
269 <table class="memname">
270 <tr>
271 <td class="memname">char * gets </td>
272 <td>(</td>
273 <td class="paramtype">char * </td>
274 <td class="paramname"><em>s</em></td><td>)</td>
275 <td></td>
276 </tr>
277 </table>
278 </div><div class="memdoc">
279 <p ><a class="el" href="stdio_8h.html#gets">gets()</a> Reads a line from stdin into a buffer pointed to by <b>s</b>.</p>
280 <dl class="params"><dt>Parameters</dt><dd>
281 <table class="params">
282 <tr><td class="paramname">s</td><td>Buffer to store string in</td></tr>
283 </table>
284 </dd>
285 </dl>
286 <p>Reads until either a terminating newline or an EOF, which it replaces with '\0'. No check for buffer overrun is performed.</p>
287 <p >Returns: Buffer pointed to by <b>s</b> </p>
288
289 </div>
290 </div>
291 <a id="getchar" name="getchar"></a>
292 <h2 class="memtitle"><span class="permalink"><a href="#getchar">◆ </a></span>getchar()</h2>
293
294 <div class="memitem">
295 <div class="memproto">
296 <table class="memname">
297 <tr>
298 <td class="memname">char getchar </td>
299 <td>(</td>
300 <td class="paramtype">void </td>
301 <td class="paramname"></td><td>)</td>
302 <td></td>
303 </tr>
304 </table>
305 </div><div class="memdoc">
306 <p ><a class="el" href="stdio_8h.html#getchar">getchar()</a> Reads and returns a single character from stdin. </p>
307
308 </div>
309 </div>
310 </div><!-- contents -->
311 </div><!-- doc-content -->
312 <!-- start footer part -->
313 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
314 <ul>
315 <li class="navelem"><a class="el" href="dir_8bd3092e915ccc8a773a74e0a10d4d15.html">gbdk-lib</a></li><li class="navelem"><a class="el" href="dir_a9f896cff747ba031115e41245385c17.html">include</a></li><li class="navelem"><a class="el" href="stdio_8h.html">stdio.h</a></li>
316 <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
317 </ul>
318 </div>
319 </body>
320 </html>
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.