pjht/os
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
os/libc/string_8h.html

506 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MyOS Kernel: libc/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" />
</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">MyOS Kernel
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<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> </div>
<div class="headertitle">
<div class="title">string.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stddef.h&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:ab68eb7b07f8ada1c6c8bde74731d3de7"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#ab68eb7b07f8ada1c6c8bde74731d3de7">memcpy</a> (void *dest, const void *src, size_t len)</td></tr>
<tr class="separator:ab68eb7b07f8ada1c6c8bde74731d3de7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e432f267691eceb2e2e0efcc37efbc9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a9e432f267691eceb2e2e0efcc37efbc9">memset</a> (void *dest, int val, size_t len)</td></tr>
<tr class="separator:a9e432f267691eceb2e2e0efcc37efbc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11bd144d7d44914099a3aeddf1c8567d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a11bd144d7d44914099a3aeddf1c8567d">strcmp</a> (const char *s1, const char *s2)</td></tr>
<tr class="separator:a11bd144d7d44914099a3aeddf1c8567d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a008e171a518fe0e0352f31b245e03875"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a008e171a518fe0e0352f31b245e03875">strlen</a> (const char *str)</td></tr>
<tr class="separator:a008e171a518fe0e0352f31b245e03875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a82515b5d377be04817715c5465b647"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a7a82515b5d377be04817715c5465b647">strcpy</a> (char *dest, const char *src)</td></tr>
<tr class="separator:a7a82515b5d377be04817715c5465b647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbb5f38c3cea2b0d6bea6e2d48627e27"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#afbb5f38c3cea2b0d6bea6e2d48627e27">strtok</a> (const char *str, const char *delim)</td></tr>
<tr class="separator:afbb5f38c3cea2b0d6bea6e2d48627e27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44060611134f89c400f1a05962f23350"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a44060611134f89c400f1a05962f23350">strrev</a> (char *str)</td></tr>
<tr class="separator:a44060611134f89c400f1a05962f23350"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8447fb0e0af198cbf05634ce587fa6fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a8447fb0e0af198cbf05634ce587fa6fe">int_to_ascii</a> (int n, char *str)</td></tr>
<tr class="separator:a8447fb0e0af198cbf05634ce587fa6fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2054893da24f5189d49fa651e4f4ae3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#ad2054893da24f5189d49fa651e4f4ae3">hex_to_ascii</a> (unsigned int n, char *str)</td></tr>
<tr class="separator:ad2054893da24f5189d49fa651e4f4ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d9776c8f21c81470d448db18fd222e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a1d9776c8f21c81470d448db18fd222e9">append</a> (char *s, char n)</td></tr>
<tr class="separator:a1d9776c8f21c81470d448db18fd222e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bf52ee3ae82986c805c8c94cc9126bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="string_8h.html#a3bf52ee3ae82986c805c8c94cc9126bf">backspace</a> (char *s)</td></tr>
<tr class="separator:a3bf52ee3ae82986c805c8c94cc9126bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1d9776c8f21c81470d448db18fd222e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d9776c8f21c81470d448db18fd222e9">&#9670;&nbsp;</a></span>append()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void append </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char&#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>Appends a character to a string </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The string </td></tr>
<tr><td class="paramname">n</td><td>The character to append </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3bf52ee3ae82986c805c8c94cc9126bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bf52ee3ae82986c805c8c94cc9126bf">&#9670;&nbsp;</a></span>backspace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void backspace </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>Deletes the last character of a string </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad2054893da24f5189d49fa651e4f4ae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2054893da24f5189d49fa651e4f4ae3">&#9670;&nbsp;</a></span>hex_to_ascii()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hex_to_ascii </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>str</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a number to a base 16 string </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The number to convert </td></tr>
<tr><td class="paramname">str</td><td>A buffer to hold the converted number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8447fb0e0af198cbf05634ce587fa6fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8447fb0e0af198cbf05634ce587fa6fe">&#9670;&nbsp;</a></span>int_to_ascii()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void int_to_ascii </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>str</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a number to a base 10 string </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The number to convert </td></tr>
<tr><td class="paramname">str</td><td>A buffer to hold the converted number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab68eb7b07f8ada1c6c8bde74731d3de7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab68eb7b07f8ada1c6c8bde74731d3de7">&#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">size_t&#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 a block of memory from one address to another </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>The destination address </td></tr>
<tr><td class="paramname">src</td><td>The source address </td></tr>
<tr><td class="paramname">len</td><td>The length of the block </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the destination address </dd></dl>
</div>
</div>
<a id="a9e432f267691eceb2e2e0efcc37efbc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e432f267691eceb2e2e0efcc37efbc9">&#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>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#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>Sets a block of memory to a byte </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>The block to set </td></tr>
<tr><td class="paramname">val</td><td>The byte to set it to </td></tr>
<tr><td class="paramname">len</td><td>The length of the block </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the destination address </dd></dl>
</div>
</div>
<a id="a11bd144d7d44914099a3aeddf1c8567d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11bd144d7d44914099a3aeddf1c8567d">&#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 two strings </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s1</td><td>String 1 to compare </td></tr>
<tr><td class="paramname">s2</td><td>String 2 to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if the strings are the same, otherwise the difference between the values of the first non-identical character </dd></dl>
</div>
</div>
<a id="a7a82515b5d377be04817715c5465b647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a82515b5d377be04817715c5465b647">&#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 a string from one address to another </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>The destination string </td></tr>
<tr><td class="paramname">src</td><td>The source string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the destination string </dd></dl>
</div>
</div>
<a id="a008e171a518fe0e0352f31b245e03875"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a008e171a518fe0e0352f31b245e03875">&#9670;&nbsp;</a></span>strlen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t strlen </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the length of a string </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The string to get the length of </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the length of the string </dd></dl>
</div>
</div>
<a id="a44060611134f89c400f1a05962f23350"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44060611134f89c400f1a05962f23350">&#9670;&nbsp;</a></span>strrev()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* strrev </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses a string in place </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The string to reverse </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the string </dd></dl>
</div>
</div>
<a id="afbb5f38c3cea2b0d6bea6e2d48627e27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbb5f38c3cea2b0d6bea6e2d48627e27">&#9670;&nbsp;</a></span>strtok()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* strtok </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>delim</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads characters from a string until it hits a delimeter character </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The string to read from (or NULL if you are continuing tokenization) </td></tr>
<tr><td class="paramname">delim</td><td>A stribg containing possible delimeter characters. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the read characters, not including the delmimeter. This string will be overwritten by sucessive calls to strtok. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_fc1eb218ab426e5adb60367f98438da0.html">libc</a></li><li class="navelem"><a class="el" href="string_8h.html">string.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink