stdio_8h.html (13557B)
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.8.20"/> 9<meta name="viewport" content="width=device-width, initial-scale=1"/> 10<title>GBDK 2020 Docs: 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_extra.css" rel="stylesheet" type="text/css"/> 23</head> 24<body> 25<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 26<div id="titlearea"> 27<table cellspacing="0" cellpadding="0"> 28 <tbody> 29 <tr style="height: 56px;"> 30 <td id="projectalign" style="padding-left: 0.5em;"> 31 <div id="projectname">GBDK 2020 Docs 32  <span id="projectnumber">4.0.6</span> 33 </div> 34 <div id="projectbrief">API Documentation for GBDK 2020</div> 35 </td> 36 </tr> 37 </tbody> 38</table> 39</div> 40<!-- end header part --> 41<!-- Generated by Doxygen 1.8.20 --> 42<script type="text/javascript"> 43/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 44var searchBox = new SearchBox("searchBox", "search",false,'Search'); 45/* @license-end */ 46</script> 47<script type="text/javascript" src="menudata.js"></script> 48<script type="text/javascript" src="menu.js"></script> 49<script type="text/javascript"> 50/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 51$(function() { 52 initMenu('',true,false,'search.php','Search'); 53 $(document).ready(function() { init_search(); }); 54}); 55/* @license-end */</script> 56<div id="main-nav"></div> 57</div><!-- top --> 58<div id="side-nav" class="ui-resizable side-nav-resizable"> 59 <div id="nav-tree"> 60 <div id="nav-tree-contents"> 61 <div id="nav-sync" class="sync"></div> 62 </div> 63 </div> 64 <div id="splitbar" style="-moz-user-select:none;" 65 class="ui-resizable-handle"> 66 </div> 67</div> 68<script type="text/javascript"> 69/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 70$(document).ready(function(){initNavTree('stdio_8h.html',''); initResizable(); }); 71/* @license-end */ 72</script> 73<div id="doc-content"> 74<!-- window showing the filter options --> 75<div id="MSearchSelectWindow" 76 onmouseover="return searchBox.OnSearchSelectShow()" 77 onmouseout="return searchBox.OnSearchSelectHide()" 78 onkeydown="return searchBox.OnSearchSelectKey(event)"> 79</div> 80 81<!-- iframe showing the search results (closed by default) --> 82<div id="MSearchResultsWindow"> 83<iframe src="javascript:void(0)" frameborder="0" 84 name="MSearchResults" id="MSearchResults"> 85</iframe> 86</div> 87 88<div class="header"> 89 <div class="summary"> 90<a href="#func-members">Functions</a> </div> 91 <div class="headertitle"> 92<div class="title">stdio.h File Reference</div> </div> 93</div><!--header--> 94<div class="contents"> 95<div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">types.h</a>></code><br /> 96</div> 97<p><a href="stdio_8h_source.html">Go to the source code of this file.</a></p> 98<table class="memberdecls"> 99<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 100Functions</h2></td></tr> 101<tr class="memitem:a9bc92fb9f23c72a66d030d4028dda72d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#a9bc92fb9f23c72a66d030d4028dda72d">putchar</a> (char <a class="el" href="sms_8h.html#a0b3366755f3276b0243c1e0497471b7a">c</a>) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 102<tr class="separator:a9bc92fb9f23c72a66d030d4028dda72d"><td class="memSeparator" colspan="2"> </td></tr> 103<tr class="memitem:ab403fa700816f08631ba75bc536f74d4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#ab403fa700816f08631ba75bc536f74d4">printf</a> (const char *format,...) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 104<tr class="separator:ab403fa700816f08631ba75bc536f74d4"><td class="memSeparator" colspan="2"> </td></tr> 105<tr class="memitem:a31913a297ee18548c81d482ef6bdbe0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#a31913a297ee18548c81d482ef6bdbe0f">sprintf</a> (char *str, const char *format,...) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 106<tr class="separator:a31913a297ee18548c81d482ef6bdbe0f"><td class="memSeparator" colspan="2"> </td></tr> 107<tr class="memitem:a299d0f9cb9e7b14e1278a4ed21e4d76f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#a299d0f9cb9e7b14e1278a4ed21e4d76f">puts</a> (const char *s)</td></tr> 108<tr class="separator:a299d0f9cb9e7b14e1278a4ed21e4d76f"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:a00a5b27bc2e5280952b02c304d7b27bc"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#a00a5b27bc2e5280952b02c304d7b27bc">gets</a> (char *s) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 110<tr class="separator:a00a5b27bc2e5280952b02c304d7b27bc"><td class="memSeparator" colspan="2"> </td></tr> 111<tr class="memitem:a2c79157c8bc2db72fbf1e34f291ff5d8"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="stdio_8h.html#a2c79157c8bc2db72fbf1e34f291ff5d8">getchar</a> () <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 112<tr class="separator:a2c79157c8bc2db72fbf1e34f291ff5d8"><td class="memSeparator" colspan="2"> </td></tr> 113</table> 114<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 115<div class="textblock"><p>Basic file/console input output functions.</p> 116<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> 117</div><h2 class="groupheader">Function Documentation</h2> 118<a id="a9bc92fb9f23c72a66d030d4028dda72d"></a> 119<h2 class="memtitle"><span class="permalink"><a href="#a9bc92fb9f23c72a66d030d4028dda72d">◆ </a></span>putchar()</h2> 120 121<div class="memitem"> 122<div class="memproto"> 123 <table class="memname"> 124 <tr> 125 <td class="memname">void putchar </td> 126 <td>(</td> 127 <td class="paramtype">char </td> 128 <td class="paramname"><em>c</em></td><td>)</td> 129 <td></td> 130 </tr> 131 </table> 132</div><div class="memdoc"> 133<p>Print char to stdout. </p><dl class="params"><dt>Parameters</dt><dd> 134 <table class="params"> 135 <tr><td class="paramname">c</td><td>Character to print </td></tr> 136 </table> 137 </dd> 138</dl> 139 140</div> 141</div> 142<a id="ab403fa700816f08631ba75bc536f74d4"></a> 143<h2 class="memtitle"><span class="permalink"><a href="#ab403fa700816f08631ba75bc536f74d4">◆ </a></span>printf()</h2> 144 145<div class="memitem"> 146<div class="memproto"> 147 <table class="memname"> 148 <tr> 149 <td class="memname">void printf </td> 150 <td>(</td> 151 <td class="paramtype">const char * </td> 152 <td class="paramname"><em>format</em>, </td> 153 </tr> 154 <tr> 155 <td class="paramkey"></td> 156 <td></td> 157 <td class="paramtype"> </td> 158 <td class="paramname"><em>...</em> </td> 159 </tr> 160 <tr> 161 <td></td> 162 <td>)</td> 163 <td></td><td></td> 164 </tr> 165 </table> 166</div><div class="memdoc"> 167<p>Print the string and arguments given by format to stdout.</p> 168<dl class="params"><dt>Parameters</dt><dd> 169 <table class="params"> 170 <tr><td class="paramname">format</td><td>The format string as per printf</td></tr> 171 </table> 172 </dd> 173</dl> 174<p>Does not return the number of characters printed.</p> 175<p>Currently supported: </p><ul> 176<li>%hx (char as hex) </li> 177<li>%hu (unsigned char) </li> 178<li>%hd (signed char) </li> 179<li>%c (character) </li> 180<li>%u (unsigned int) </li> 181<li>%d (signed int) </li> 182<li>%x (unsigned int as hex) </li> 183<li>%s (string)</li> 184</ul> 185<p>Warning: to correctly pass chars for printing as chars, they <em>must</em> be explicitly re-cast as such when calling the function. See <a class="el" href="docs_coding_guidelines.html#docs_chars_varargs">docs_chars_varargs</a> for more details. </p> 186 187</div> 188</div> 189<a id="a31913a297ee18548c81d482ef6bdbe0f"></a> 190<h2 class="memtitle"><span class="permalink"><a href="#a31913a297ee18548c81d482ef6bdbe0f">◆ </a></span>sprintf()</h2> 191 192<div class="memitem"> 193<div class="memproto"> 194 <table class="memname"> 195 <tr> 196 <td class="memname">void sprintf </td> 197 <td>(</td> 198 <td class="paramtype">char * </td> 199 <td class="paramname"><em>str</em>, </td> 200 </tr> 201 <tr> 202 <td class="paramkey"></td> 203 <td></td> 204 <td class="paramtype">const char * </td> 205 <td class="paramname"><em>format</em>, </td> 206 </tr> 207 <tr> 208 <td class="paramkey"></td> 209 <td></td> 210 <td class="paramtype"> </td> 211 <td class="paramname"><em>...</em> </td> 212 </tr> 213 <tr> 214 <td></td> 215 <td>)</td> 216 <td></td><td></td> 217 </tr> 218 </table> 219</div><div class="memdoc"> 220<p>Print the string and arguments given by format to a buffer.</p> 221<dl class="params"><dt>Parameters</dt><dd> 222 <table class="params"> 223 <tr><td class="paramname">str</td><td>The buffer to print into </td></tr> 224 <tr><td class="paramname">format</td><td>The format string as per <a class="el" href="stdio_8h.html#ab403fa700816f08631ba75bc536f74d4">printf</a></td></tr> 225 </table> 226 </dd> 227</dl> 228<p>Does not return the number of characters printed. </p> 229 230</div> 231</div> 232<a id="a299d0f9cb9e7b14e1278a4ed21e4d76f"></a> 233<h2 class="memtitle"><span class="permalink"><a href="#a299d0f9cb9e7b14e1278a4ed21e4d76f">◆ </a></span>puts()</h2> 234 235<div class="memitem"> 236<div class="memproto"> 237 <table class="memname"> 238 <tr> 239 <td class="memname">void puts </td> 240 <td>(</td> 241 <td class="paramtype">const char * </td> 242 <td class="paramname"><em>s</em></td><td>)</td> 243 <td></td> 244 </tr> 245 </table> 246</div><div class="memdoc"> 247<p><a class="el" href="stdio_8h.html#a299d0f9cb9e7b14e1278a4ed21e4d76f">puts()</a> writes the string <b>s</b> and a trailing newline to stdout. </p> 248 249</div> 250</div> 251<a id="a00a5b27bc2e5280952b02c304d7b27bc"></a> 252<h2 class="memtitle"><span class="permalink"><a href="#a00a5b27bc2e5280952b02c304d7b27bc">◆ </a></span>gets()</h2> 253 254<div class="memitem"> 255<div class="memproto"> 256 <table class="memname"> 257 <tr> 258 <td class="memname">char* gets </td> 259 <td>(</td> 260 <td class="paramtype">char * </td> 261 <td class="paramname"><em>s</em></td><td>)</td> 262 <td></td> 263 </tr> 264 </table> 265</div><div class="memdoc"> 266<p><a class="el" href="stdio_8h.html#a00a5b27bc2e5280952b02c304d7b27bc">gets()</a> Reads a line from stdin into a buffer pointed to by <b>s</b>.</p> 267<dl class="params"><dt>Parameters</dt><dd> 268 <table class="params"> 269 <tr><td class="paramname">s</td><td>Buffer to store string in</td></tr> 270 </table> 271 </dd> 272</dl> 273<p>Reads until either a terminating newline or an EOF, which it replaces with '\0'. No check for buffer overrun is performed.</p> 274<p>Returns: Buffer pointed to by <b>s</b> </p> 275 276</div> 277</div> 278<a id="a2c79157c8bc2db72fbf1e34f291ff5d8"></a> 279<h2 class="memtitle"><span class="permalink"><a href="#a2c79157c8bc2db72fbf1e34f291ff5d8">◆ </a></span>getchar()</h2> 280 281<div class="memitem"> 282<div class="memproto"> 283 <table class="memname"> 284 <tr> 285 <td class="memname">char getchar </td> 286 <td>(</td> 287 <td class="paramname"></td><td>)</td> 288 <td></td> 289 </tr> 290 </table> 291</div><div class="memdoc"> 292<p><a class="el" href="stdio_8h.html#a2c79157c8bc2db72fbf1e34f291ff5d8">getchar()</a> Reads and returns a single character from stdin. </p> 293 294</div> 295</div> 296</div><!-- contents --> 297</div><!-- doc-content --> 298<!-- HTML footer for doxygen 1.8.14--> 299<!-- start footer part --> 300<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 301</div> 302</body> 303</html>