diff options
Diffstat (limited to 'gbdk/docs/api/asm_2gbz80_2string_8h.html')
| -rw-r--r-- | gbdk/docs/api/asm_2gbz80_2string_8h.html | 640 |
1 files changed, 640 insertions, 0 deletions
diff --git a/gbdk/docs/api/asm_2gbz80_2string_8h.html b/gbdk/docs/api/asm_2gbz80_2string_8h.html new file mode 100644 index 00000000..59c7cf2e --- /dev/null +++ b/gbdk/docs/api/asm_2gbz80_2string_8h.html @@ -0,0 +1,640 @@ +<!-- 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: asm/gbz80/string.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('asm_2gbz80_2string_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> | +<a href="#var-members">Variables</a> </div> + <div class="headertitle"> +<div class="title">string.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <<a class="el" href="asm_2gbz80_2types_8h_source.html">types.h</a>></code><br /> +</div> +<p><a href="asm_2gbz80_2string_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:ada128b5ed545214bb397d1399615ec9e"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#ada128b5ed545214bb397d1399615ec9e">strcpy</a> (char *dest, const char *src) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> +<tr class="separator:ada128b5ed545214bb397d1399615ec9e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7172770a053aa1fe0ab46a97ab43a5fa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a7172770a053aa1fe0ab46a97ab43a5fa">strcmp</a> (const char *s1, const char *s2) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> +<tr class="separator:a7172770a053aa1fe0ab46a97ab43a5fa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a1a6cbe7fb6102819098340a4986574"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a6a1a6cbe7fb6102819098340a4986574">memcpy</a> (void *dest, const void *src, <a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> len) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> +<tr class="separator:a6a1a6cbe7fb6102819098340a4986574"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a802c986820d3866639922b6bc9484f90"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a802c986820d3866639922b6bc9484f90">memmove</a> (void *dest, const void *src, <a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> n)</td></tr> +<tr class="separator:a802c986820d3866639922b6bc9484f90"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4bc4146b1a053fc4ec10f1377bb21a4f"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a4bc4146b1a053fc4ec10f1377bb21a4f">memset</a> (void *s, int <a class="el" href="sms_8h.html#a0b3366755f3276b0243c1e0497471b7a">c</a>, <a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> n) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> +<tr class="separator:a4bc4146b1a053fc4ec10f1377bb21a4f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a476b2b37367c65c6cb36037bfc16b19f"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a476b2b37367c65c6cb36037bfc16b19f">reverse</a> (char *s) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> +<tr class="separator:a476b2b37367c65c6cb36037bfc16b19f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8908188ae9fc2f05d993257ef001d553"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a8908188ae9fc2f05d993257ef001d553">strcat</a> (char *s1, const char *s2)</td></tr> +<tr class="separator:a8908188ae9fc2f05d993257ef001d553"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5e4982e9d2fd4ec328abfda6b1a3f7e5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a5e4982e9d2fd4ec328abfda6b1a3f7e5">strlen</a> (const char *s) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> +<tr class="separator:a5e4982e9d2fd4ec328abfda6b1a3f7e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af70714f788819be9dbf368a969be23f7"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#af70714f788819be9dbf368a969be23f7">strncat</a> (char *s1, const char *s2, int n)</td></tr> +<tr class="separator:af70714f788819be9dbf368a969be23f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab745ed93c0024648f33dc1d553e9fdcc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#ab745ed93c0024648f33dc1d553e9fdcc">strncmp</a> (const char *s1, const char *s2, int n)</td></tr> +<tr class="separator:ab745ed93c0024648f33dc1d553e9fdcc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a21ae87d60fcc456369668093c57db61f"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a21ae87d60fcc456369668093c57db61f">strncpy</a> (char *s1, const char *s2, int n)</td></tr> +<tr class="separator:a21ae87d60fcc456369668093c57db61f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a52701f453c97403ec1b12d286484259b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a52701f453c97403ec1b12d286484259b">memcmp</a> (const void *buf1, const void *buf2, <a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> count) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> +<tr class="separator:a52701f453c97403ec1b12d286484259b"><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:a0b3366755f3276b0243c1e0497471b7a"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2gbz80_2string_8h.html#a0b3366755f3276b0243c1e0497471b7a">c</a></td></tr> +<tr class="separator:a0b3366755f3276b0243c1e0497471b7a"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Generic string functions. </p> +</div><h2 class="groupheader">Function Documentation</h2> +<a id="ada128b5ed545214bb397d1399615ec9e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ada128b5ed545214bb397d1399615ec9e">◆ </a></span>strcpy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* strcpy </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>dest</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>src</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Copies the string pointed to by <b>src</b> (including the terminating ‘\0’ character) to the array pointed to by <b>dest</b>.</p> +<p>The strings may not overlap, and the destination string dest must be large enough to receive the copy.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dest</td><td>Array to copy into </td></tr> + <tr><td class="paramname">src</td><td>Array to copy from</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to dest </dd></dl> + +</div> +</div> +<a id="a7172770a053aa1fe0ab46a97ab43a5fa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7172770a053aa1fe0ab46a97ab43a5fa">◆ </a></span>strcmp()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int strcmp </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Compares strings</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s1</td><td>First string to compare </td></tr> + <tr><td class="paramname">s2</td><td>Second string to compare</td></tr> + </table> + </dd> +</dl> +<p>Returns: </p><ul> +<li>> 0 if <b>s1</b> > <b>s2</b> </li> +<li>0 if <b>s1</b> == <b>s2</b> </li> +<li>< 0 if <b>s1</b> < <b>s2</b> </li> +</ul> + +</div> +</div> +<a id="a6a1a6cbe7fb6102819098340a4986574"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6a1a6cbe7fb6102819098340a4986574">◆ </a></span>memcpy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* memcpy </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>dest</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>src</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> </td> + <td class="paramname"><em>len</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Copies n bytes from memory area src to memory area dest.</p> +<p>The memory areas may not overlap.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dest</td><td>Buffer to copy into </td></tr> + <tr><td class="paramname">src</td><td>Buffer to copy from </td></tr> + <tr><td class="paramname">len</td><td>Number of Bytes to copy </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a802c986820d3866639922b6bc9484f90"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a802c986820d3866639922b6bc9484f90">◆ </a></span>memmove()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* memmove </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>dest</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>src</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> </td> + <td class="paramname"><em>n</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Copies n bytes from memory area src to memory area dest, areas may overlap </p> + +</div> +</div> +<a id="a4bc4146b1a053fc4ec10f1377bb21a4f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4bc4146b1a053fc4ec10f1377bb21a4f">◆ </a></span>memset()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* memset </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>s</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>c</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> </td> + <td class="paramname"><em>n</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Fills the memory region <b>s</b> with <b>n</b> bytes using value <b>c</b></p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s</td><td>Buffer to fill </td></tr> + <tr><td class="paramname">c</td><td>char value to fill with (truncated from int) </td></tr> + <tr><td class="paramname">n</td><td>Number of bytes to fill </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a476b2b37367c65c6cb36037bfc16b19f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a476b2b37367c65c6cb36037bfc16b19f">◆ </a></span>reverse()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* reverse </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>Reverses the characters in a string</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s</td><td>Pointer to string to reverse.</td></tr> + </table> + </dd> +</dl> +<p>For example 'abcdefg' will become 'gfedcba'.</p> +<p>Banked as the string must be modifiable.</p> +<p>Returns: Pointer to <b>s</b> </p> + +</div> +</div> +<a id="a8908188ae9fc2f05d993257ef001d553"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8908188ae9fc2f05d993257ef001d553">◆ </a></span>strcat()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* strcat </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>s1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Concatenate Strings. Appends string <b>s2</b> to the end of string <b>s1</b></p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s1</td><td>String to append onto </td></tr> + <tr><td class="paramname">s2</td><td>String to copy from</td></tr> + </table> + </dd> +</dl> +<p>For example 'abc' and 'def' will become 'abcdef'.</p> +<p>String <b>s1</b> must be large enough to store both <b>s1</b> and <b>s2</b>.</p> +<p>Returns: Pointer to <b>s1</b> </p> + +</div> +</div> +<a id="a5e4982e9d2fd4ec328abfda6b1a3f7e5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5e4982e9d2fd4ec328abfda6b1a3f7e5">◆ </a></span>strlen()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int strlen </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>Calculates the length of a string</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s</td><td>String to calculate length of</td></tr> + </table> + </dd> +</dl> +<p>Returns: Length of string not including the terminating ‘\0’ character. </p> + +</div> +</div> +<a id="af70714f788819be9dbf368a969be23f7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af70714f788819be9dbf368a969be23f7">◆ </a></span>strncat()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* strncat </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>s1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s2</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>n</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Concatenate at most <b>n</b> characters from string <b>s2</b> onto the end of <b>s1</b>.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s1</td><td>String to append onto </td></tr> + <tr><td class="paramname">s2</td><td>String to copy from </td></tr> + <tr><td class="paramname">n</td><td>Max number of characters to copy from <b>s2</b></td></tr> + </table> + </dd> +</dl> +<p>String <b>s1</b> must be large enough to store both <b>s1</b> and <b>n</b> characters of <b>s2</b></p> +<p>Returns: Pointer to <b>s1</b> </p> + +</div> +</div> +<a id="ab745ed93c0024648f33dc1d553e9fdcc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab745ed93c0024648f33dc1d553e9fdcc">◆ </a></span>strncmp()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int strncmp </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s2</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>n</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Compare strings (at most <b>n</b> characters):</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s1</td><td>First string to compare </td></tr> + <tr><td class="paramname">s2</td><td>Second string to compare </td></tr> + <tr><td class="paramname">n</td><td>Max number of characters to compare</td></tr> + </table> + </dd> +</dl> +<p>Returns zero if the strings are identical, or non-zero if they are not (see below).</p> +<p>Returns: </p><ul> +<li>> 0 if <b>s1</b> > <b>s2</b> (at first non-matching byte) </li> +<li>0 if <b>s1</b> == <b>s2</b> </li> +<li>< 0 if <b>s1</b> < <b>s2</b> (at first non-matching byte) </li> +</ul> + +</div> +</div> +<a id="a21ae87d60fcc456369668093c57db61f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a21ae87d60fcc456369668093c57db61f">◆ </a></span>strncpy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* strncpy </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>s1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s2</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>n</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Copy <b>n</b> characters from string <b>s2</b> to <b>s1</b></p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s1</td><td>String to copy into </td></tr> + <tr><td class="paramname">s2</td><td>String to copy from </td></tr> + <tr><td class="paramname">n</td><td>Max number of characters to copy from <b>s2</b></td></tr> + </table> + </dd> +</dl> +<p>If <b>s2</b> is shorter than <b>n</b>, the remaining bytes in <b>s1</b> are filled with \0.</p> +<p>Warning: If there is no \0 in the first <b>n</b> bytes of <b>s2</b> then <b>s1</b> will not be null terminated.</p> +<p>Returns: Pointer to <b>s1</b> </p> + +</div> +</div> +<a id="a52701f453c97403ec1b12d286484259b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a52701f453c97403ec1b12d286484259b">◆ </a></span>memcmp()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int memcmp </td> + <td>(</td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>buf1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>buf2</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="asm_2gbz80_2types_8h.html#a7c94ea6f8948649f8d181ae55911eeaf">size_t</a> </td> + <td class="paramname"><em>count</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Compare up to <b>count</b> bytes in buffers <b>buf1</b> and <b>buf2</b></p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">buf1</td><td>Pointer to First buffer to compare </td></tr> + <tr><td class="paramname">buf2</td><td>Pointer to Second buffer to compare </td></tr> + <tr><td class="paramname">count</td><td>Max number of bytes to compare</td></tr> + </table> + </dd> +</dl> +<p>Returns zero if the buffers are identical, or non-zero if they are not (see below).</p> +<p>Returns: </p><ul> +<li>> 0 if <b>buf1</b> > <b>buf2</b> (at first non-matching byte) </li> +<li>0 if <b>buf1</b> == <b>buf2</b> </li> +<li>< 0 if <b>buf1</b> < <b>buf2</b> (at first non-matching byte) </li> +</ul> + +</div> +</div> +<h2 class="groupheader">Variable Documentation</h2> +<a id="a0b3366755f3276b0243c1e0497471b7a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0b3366755f3276b0243c1e0497471b7a">◆ </a></span>c</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void c</td> + </tr> + </table> +</div><div class="memdoc"> + +</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> |