blob: d951110a0d72fedb6e957b32b34c3c04fd864a16 [file] [log] [blame]
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libguac: guacamole/string.h Source File</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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">libguac<span id="projectnumber">&#160;1.5.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">string.h</div></div>
</div><!--header-->
<div class="contents">
<a href="string_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef GUAC_STRING_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define GUAC_STRING_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;<a class="code" href="string_8h.html">string.h</a>&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="string_8h.html#add551909cdd14d762106832a800a5e16"> 65</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="string_8h.html#add551909cdd14d762106832a800a5e16">guac_strlcpy</a>(<span class="keywordtype">char</span>* restrict dest, <span class="keyword">const</span> <span class="keywordtype">char</span>* restrict src, <span class="keywordtype">size_t</span> n);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="string_8h.html#a0dccfb28be71414fb2a4b1b641799f57"> 110</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="string_8h.html#a0dccfb28be71414fb2a4b1b641799f57">guac_strlcat</a>(<span class="keywordtype">char</span>* restrict dest, <span class="keyword">const</span> <span class="keywordtype">char</span>* restrict src, <span class="keywordtype">size_t</span> n);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="string_8h.html#aa29a3e046b785d93e1db17f33f3e996e"> 132</a></span><span class="keywordtype">char</span>* <a class="code hl_function" href="string_8h.html#aa29a3e046b785d93e1db17f33f3e996e">guac_strnstr</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *haystack, <span class="keyword">const</span> <span class="keywordtype">char</span> *needle, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="string_8h.html#ac446136fc070b071862d422b777eafc3"> 145</a></span><span class="keywordtype">char</span>* <a class="code hl_function" href="string_8h.html#ac446136fc070b071862d422b777eafc3">guac_strdup</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"><a class="line" href="string_8h.html#a186ea73f38cfaf14f8a5b13ad7e9724f"> 192</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="string_8h.html#a186ea73f38cfaf14f8a5b13ad7e9724f">guac_strljoin</a>(<span class="keywordtype">char</span>* restrict dest, <span class="keyword">const</span> <span class="keywordtype">char</span>* restrict <span class="keyword">const</span>* elements,</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> <span class="keywordtype">int</span> nmemb, <span class="keyword">const</span> <span class="keywordtype">char</span>* restrict delim, <span class="keywordtype">size_t</span> n);</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> </div>
<div class="ttc" id="astring_8h_html"><div class="ttname"><a href="string_8h.html">string.h</a></div><div class="ttdoc">Provides convenience functions for manipulating strings.</div></div>
<div class="ttc" id="astring_8h_html_a0dccfb28be71414fb2a4b1b641799f57"><div class="ttname"><a href="string_8h.html#a0dccfb28be71414fb2a4b1b641799f57">guac_strlcat</a></div><div class="ttdeci">size_t guac_strlcat(char *restrict dest, const char *restrict src, size_t n)</div><div class="ttdoc">Appends the given source string after the end of the given destination string, writing at most the gi...</div></div>
<div class="ttc" id="astring_8h_html_a186ea73f38cfaf14f8a5b13ad7e9724f"><div class="ttname"><a href="string_8h.html#a186ea73f38cfaf14f8a5b13ad7e9724f">guac_strljoin</a></div><div class="ttdeci">size_t guac_strljoin(char *restrict dest, const char *restrict const *elements, int nmemb, const char *restrict delim, size_t n)</div><div class="ttdoc">Concatenates each of the given strings, separated by the given delimiter, storing the result within a...</div></div>
<div class="ttc" id="astring_8h_html_aa29a3e046b785d93e1db17f33f3e996e"><div class="ttname"><a href="string_8h.html#aa29a3e046b785d93e1db17f33f3e996e">guac_strnstr</a></div><div class="ttdeci">char * guac_strnstr(const char *haystack, const char *needle, size_t len)</div><div class="ttdoc">Search for the null-terminated string needle in the possibly null- terminated haystack,...</div></div>
<div class="ttc" id="astring_8h_html_ac446136fc070b071862d422b777eafc3"><div class="ttname"><a href="string_8h.html#ac446136fc070b071862d422b777eafc3">guac_strdup</a></div><div class="ttdeci">char * guac_strdup(const char *str)</div><div class="ttdoc">Simple wrapper for strdup() which behaves identically to standard strdup(), except that NULL will be ...</div></div>
<div class="ttc" id="astring_8h_html_add551909cdd14d762106832a800a5e16"><div class="ttname"><a href="string_8h.html#add551909cdd14d762106832a800a5e16">guac_strlcpy</a></div><div class="ttdeci">size_t guac_strlcpy(char *restrict dest, const char *restrict src, size_t n)</div><div class="ttdoc">Copies a limited number of bytes from the given source string to the given destination buffer.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>