diff options
Diffstat (limited to 'gbdk/docs/api/stdio_8h.html')
| -rw-r--r-- | gbdk/docs/api/stdio_8h.html | 303 |
1 files changed, 303 insertions, 0 deletions
diff --git a/gbdk/docs/api/stdio_8h.html b/gbdk/docs/api/stdio_8h.html new file mode 100644 index 00000000..b84a4dc6 --- /dev/null +++ b/gbdk/docs/api/stdio_8h.html @@ -0,0 +1,303 @@ +<!-- HTML header for doxygen 1.8.14--> +<!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="cache-control" content="max-age=86400"/> +<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.20"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>GBDK 2020 Docs: stdio.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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="doxygen_extra.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 id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">GBDK 2020 Docs +  <span id="projectnumber">4.0.6</span> + </div> + <div id="projectbrief">API Documentation for GBDK 2020</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.20 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('stdio_8h.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">stdio.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">types.h</a>></code><br /> +</div> +<p><a href="stdio_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<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> +<tr class="separator:a9bc92fb9f23c72a66d030d4028dda72d"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:ab403fa700816f08631ba75bc536f74d4"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a31913a297ee18548c81d482ef6bdbe0f"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a299d0f9cb9e7b14e1278a4ed21e4d76f"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a00a5b27bc2e5280952b02c304d7b27bc"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a2c79157c8bc2db72fbf1e34f291ff5d8"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Basic file/console input output functions.</p> +<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> +</div><h2 class="groupheader">Function Documentation</h2> +<a id="a9bc92fb9f23c72a66d030d4028dda72d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9bc92fb9f23c72a66d030d4028dda72d">◆ </a></span>putchar()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void putchar </td> + <td>(</td> + <td class="paramtype">char </td> + <td class="paramname"><em>c</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Print char to stdout. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">c</td><td>Character to print </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ab403fa700816f08631ba75bc536f74d4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab403fa700816f08631ba75bc536f74d4">◆ </a></span>printf()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void printf </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Print the string and arguments given by format to stdout.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">format</td><td>The format string as per printf</td></tr> + </table> + </dd> +</dl> +<p>Does not return the number of characters printed.</p> +<p>Currently supported: </p><ul> +<li>%hx (char as hex) </li> +<li>%hu (unsigned char) </li> +<li>%hd (signed char) </li> +<li>%c (character) </li> +<li>%u (unsigned int) </li> +<li>%d (signed int) </li> +<li>%x (unsigned int as hex) </li> +<li>%s (string)</li> +</ul> +<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> + +</div> +</div> +<a id="a31913a297ee18548c81d482ef6bdbe0f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a31913a297ee18548c81d482ef6bdbe0f">◆ </a></span>sprintf()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sprintf </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Print the string and arguments given by format to a buffer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str</td><td>The buffer to print into </td></tr> + <tr><td class="paramname">format</td><td>The format string as per <a class="el" href="stdio_8h.html#ab403fa700816f08631ba75bc536f74d4">printf</a></td></tr> + </table> + </dd> +</dl> +<p>Does not return the number of characters printed. </p> + +</div> +</div> +<a id="a299d0f9cb9e7b14e1278a4ed21e4d76f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a299d0f9cb9e7b14e1278a4ed21e4d76f">◆ </a></span>puts()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void puts </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p><a class="el" href="stdio_8h.html#a299d0f9cb9e7b14e1278a4ed21e4d76f">puts()</a> writes the string <b>s</b> and a trailing newline to stdout. </p> + +</div> +</div> +<a id="a00a5b27bc2e5280952b02c304d7b27bc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a00a5b27bc2e5280952b02c304d7b27bc">◆ </a></span>gets()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* gets </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>s</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s</td><td>Buffer to store string in</td></tr> + </table> + </dd> +</dl> +<p>Reads until either a terminating newline or an EOF, which it replaces with '\0'. No check for buffer overrun is performed.</p> +<p>Returns: Buffer pointed to by <b>s</b> </p> + +</div> +</div> +<a id="a2c79157c8bc2db72fbf1e34f291ff5d8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2c79157c8bc2db72fbf1e34f291ff5d8">◆ </a></span>getchar()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char getchar </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p><a class="el" href="stdio_8h.html#a2c79157c8bc2db72fbf1e34f291ff5d8">getchar()</a> Reads and returns a single character from stdin. </p> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> +</div> +</body> +</html> |