Mirrors/gbdk-2020
2
0
Fork 0
mirror of https://github.com/gbdk-2020/gbdk-2020.git synced 2026-03-09 16:57:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
5ce20c7740a76cf378c080ecd919eb464d6a6a22
gbdk-2020/docs/api/string_8h.html
Toxa 340ecd6304 update docs
2021-02-08 11:50:39 +03:00

588 lines
25 KiB
HTML
Raw Blame History

<!-- 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: 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
</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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('string_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> &#124;
<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 &lt;<a class="el" href="types_8h_source.html">types.h</a>&gt;</code><br />
</div>
<p><a href="string_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:ad724f30223364304479b0fc714435e78"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#ad724f30223364304479b0fc714435e78">strcpy</a> (char *dest, const char *src) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a> __preserves_regs(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr>
<tr class="separator:ad724f30223364304479b0fc714435e78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa89031476b4f6ee827f9163d09d68043"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#aa89031476b4f6ee827f9163d09d68043">strcmp</a> (const char *s1, const char *s2) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a> __preserves_regs(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr>
<tr class="separator:aa89031476b4f6ee827f9163d09d68043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bb96f23101e1f8c053a36d59a01d3f8"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a1bb96f23101e1f8c053a36d59a01d3f8">memcpy</a> (void *dest, const void *src, <a class="el" href="asm_2gbz80_2types_8h.html#a7619b847aeded8a6d14cbfa212b2cdfb">size_t</a> len) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a> __preserves_regs(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr>
<tr class="separator:a1bb96f23101e1f8c053a36d59a01d3f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a802c986820d3866639922b6bc9484f90"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a802c986820d3866639922b6bc9484f90">memmove</a> (void *dest, const void *src, <a class="el" href="asm_2gbz80_2types_8h.html#a7619b847aeded8a6d14cbfa212b2cdfb">size_t</a> n)</td></tr>
<tr class="separator:a802c986820d3866639922b6bc9484f90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23e7549e1468d21419457759150fa767"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a23e7549e1468d21419457759150fa767">memset</a> (void *s, int <a class="el" href="string_8h.html#a4e1e0e72dd773439e333c84dd762a9c3">c</a>, <a class="el" href="asm_2gbz80_2types_8h.html#a7619b847aeded8a6d14cbfa212b2cdfb">size_t</a> n) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a> __preserves_regs(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr>
<tr class="separator:a23e7549e1468d21419457759150fa767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af71f9ead43b3760680da8ab1bd3f783b"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#af71f9ead43b3760680da8ab1bd3f783b">reverse</a> (char *s) __preserves_regs(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr>
<tr class="separator:af71f9ead43b3760680da8ab1bd3f783b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13c88f5a8475fd7de5d81553cb29724a"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a13c88f5a8475fd7de5d81553cb29724a">strcat</a> (char *s1, const char *s2) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a></td></tr>
<tr class="separator:a13c88f5a8475fd7de5d81553cb29724a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fd73083ebdcca16ad810cd6041466f2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a8fd73083ebdcca16ad810cd6041466f2">strlen</a> (const char *s) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a> __preserves_regs(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr>
<tr class="separator:a8fd73083ebdcca16ad810cd6041466f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a168580a0ddcb7fe754a711309966c99d"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a168580a0ddcb7fe754a711309966c99d">strncat</a> (char *s1, const char *s2, int n) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a></td></tr>
<tr class="separator:a168580a0ddcb7fe754a711309966c99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a861dba2d93de82f087707bb795f5c602"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a861dba2d93de82f087707bb795f5c602">strncmp</a> (const char *s1, const char *s2, int n) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a></td></tr>
<tr class="separator:a861dba2d93de82f087707bb795f5c602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a796a9459c4f362e51c00307044c40ed5"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a796a9459c4f362e51c00307044c40ed5">strncpy</a> (char *s1, const char *s2, int n) <a class="el" href="asm_2gbz80_2types_8h.html#a7ed081d8dfb6902784b2fc730bbb7f96">NONBANKED</a></td></tr>
<tr class="separator:a796a9459c4f362e51c00307044c40ed5"><td class="memSeparator" colspan="2">&#160;</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:a4e1e0e72dd773439e333c84dd762a9c3"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a4e1e0e72dd773439e333c84dd762a9c3">c</a></td></tr>
<tr class="separator:a4e1e0e72dd773439e333c84dd762a9c3"><td class="memSeparator" colspan="2">&#160;</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="ad724f30223364304479b0fc714435e78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad724f30223364304479b0fc714435e78">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>src</em>&#160;</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 &lsquo;\0&rsquo; 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="aa89031476b4f6ee827f9163d09d68043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa89031476b4f6ee827f9163d09d68043">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>s2</em>&#160;</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>&gt; 0 if <b>s1</b> &gt; <b>s2</b> </li>
<li>0 if <b>s1</b> == <b>s2</b> </li>
<li>&lt; 0 if <b>s1</b> &lt; <b>s2</b> </li>
</ul>
</div>
</div>
<a id="a1bb96f23101e1f8c053a36d59a01d3f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bb96f23101e1f8c053a36d59a01d3f8">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</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#a7619b847aeded8a6d14cbfa212b2cdfb">size_t</a>&#160;</td>
<td class="paramname"><em>len</em>&#160;</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">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</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#a7619b847aeded8a6d14cbfa212b2cdfb">size_t</a>&#160;</td>
<td class="paramname"><em>n</em>&#160;</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="a23e7549e1468d21419457759150fa767"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23e7549e1468d21419457759150fa767">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</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#a7619b847aeded8a6d14cbfa212b2cdfb">size_t</a>&#160;</td>
<td class="paramname"><em>n</em>&#160;</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="af71f9ead43b3760680da8ab1bd3f783b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af71f9ead43b3760680da8ab1bd3f783b">&#9670;&nbsp;</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 *&#160;</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="a13c88f5a8475fd7de5d81553cb29724a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13c88f5a8475fd7de5d81553cb29724a">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>s2</em>&#160;</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="a8fd73083ebdcca16ad810cd6041466f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fd73083ebdcca16ad810cd6041466f2">&#9670;&nbsp;</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 *&#160;</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 &lsquo;\0&rsquo; character. </p>
</div>
</div>
<a id="a168580a0ddcb7fe754a711309966c99d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a168580a0ddcb7fe754a711309966c99d">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>s2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>n</em>&#160;</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="a861dba2d93de82f087707bb795f5c602"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a861dba2d93de82f087707bb795f5c602">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>s2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>n</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare strings (at most n 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: </p><ul>
<li>&gt; 0 if <b>s1</b> &gt; <b>s2</b> </li>
<li>0 if <b>s1</b> == <b>s2</b> </li>
<li>&lt; 0 if <b>s1</b> &lt; <b>s2</b> </li>
</ul>
</div>
</div>
<a id="a796a9459c4f362e51c00307044c40ed5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a796a9459c4f362e51c00307044c40ed5">&#9670;&nbsp;</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 *&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>s2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>n</em>&#160;</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>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a4e1e0e72dd773439e333c84dd762a9c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e1e0e72dd773439e333c84dd762a9c3">&#9670;&nbsp;</a></span>c</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int 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>
Reference in New Issue View Git Blame Copy Permalink