gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/asm_2sm83_2string_8h.html
1 <!-- HTML header for doxygen 1.8.14-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="cache-control" content="max-age=86400"/>
6 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
8 <meta name="generator" content="Doxygen 1.9.2"/>
9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
10 <title>GBDK 2020 Docs: gbdk-lib/include/asm/sm83/string.h File Reference</title>
11 <link href="tabs.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="jquery.js"></script>
13 <script type="text/javascript" src="dynsections.js"></script>
14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
15 <script type="text/javascript" src="resize.js"></script>
16 <script type="text/javascript" src="navtreedata.js"></script>
17 <script type="text/javascript" src="navtree.js"></script>
18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="search/searchdata.js"></script>
20 <script type="text/javascript" src="search/search.js"></script>
21 <link href="doxygen.css" rel="stylesheet" type="text/css" />
22 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25 <!-- BEGIN: doxygen-awesome-css -->
26 <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
27 <script type="text/javascript">
28 DoxygenAwesomeDarkModeToggle.init()
29 </script>
30 <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
31 <script type="text/javascript">
32 DoxygenAwesomeParagraphLink.init()
33 </script>
34 <!-- END: doxygen-awesome-css -->
35 </head>
36 <body>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <div id="titlearea">
39 <table cellspacing="0" cellpadding="0">
40 <tbody>
41 <tr style="height: 56px;">
42 <td id="projectalign" style="padding-left: 0.5em;">
43 <div id="projectname">GBDK 2020 Docs
44  <span id="projectnumber">4.5.0</span>
45 </div>
46 <div id="projectbrief">API Documentation for GBDK 2020</div>
47 </td>
48 </tr>
49 </tbody>
50 </table>
51 </div>
52 <!-- end header part -->
53 <!-- Generated by Doxygen 1.9.2 -->
54 <script type="text/javascript">
55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
57 /* @license-end */
58 </script>
59 <script type="text/javascript" src="menudata.js"></script>
60 <script type="text/javascript" src="menu.js"></script>
61 <script type="text/javascript">
62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
63 $(function() {
64 initMenu('',true,false,'search.php','Search');
65 $(document).ready(function() { init_search(); });
66 });
67 /* @license-end */
68 </script>
69 <div id="main-nav"></div>
70 </div><!-- top -->
71 <div id="side-nav" class="ui-resizable side-nav-resizable">
72 <div id="nav-tree">
73 <div id="nav-tree-contents">
74 <div id="nav-sync" class="sync"></div>
75 </div>
76 </div>
77 <div id="splitbar" style="-moz-user-select:none;"
78 class="ui-resizable-handle">
79 </div>
80 </div>
81 <script type="text/javascript">
82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
83 $(document).ready(function(){initNavTree('asm_2sm83_2string_8h.html',''); initResizable(); });
84 /* @license-end */
85 </script>
86 <div id="doc-content">
87 <!-- window showing the filter options -->
88 <div id="MSearchSelectWindow"
89 onmouseover="return searchBox.OnSearchSelectShow()"
90 onmouseout="return searchBox.OnSearchSelectHide()"
91 onkeydown="return searchBox.OnSearchSelectKey(event)">
92 </div>
93
94 <!-- iframe showing the search results (closed by default) -->
95 <div id="MSearchResultsWindow">
96 <iframe src="javascript:void(0)" frameborder="0"
97 name="MSearchResults" id="MSearchResults">
98 </iframe>
99 </div>
100
101 <div class="header">
102 <div class="summary">
103 <a href="#func-members">Functions</a> |
104 <a href="#var-members">Variables</a> </div>
105 <div class="headertitle"><div class="title">string.h File Reference</div></div>
106 </div><!--header-->
107 <div class="contents">
108 <div class="textblock"><code>#include <<a class="el" href="asm_2sm83_2types_8h_source.html">types.h</a>></code><br />
109 </div>
110 <p><a href="asm_2sm83_2string_8h_source.html">Go to the source code of this file.</a></p>
111 <table class="memberdecls">
112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
113 Functions</h2></td></tr>
114 <tr class="memitem:strcpy"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#strcpy">strcpy</a> (char *dest, const char *src) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#b">b</a></td></tr>
115 <tr class="separator:strcpy"><td class="memSeparator" colspan="2"> </td></tr>
116 <tr class="memitem:strcmp"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#strcmp">strcmp</a> (const char *s1, const char *s2) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#b">b</a></td></tr>
117 <tr class="separator:strcmp"><td class="memSeparator" colspan="2"> </td></tr>
118 <tr class="memitem:memcpy"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#memcpy">memcpy</a> (void *dest, const void *src, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> len)</td></tr>
119 <tr class="separator:memcpy"><td class="memSeparator" colspan="2"> </td></tr>
120 <tr class="memitem:memmove"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#memmove">memmove</a> (void *dest, const void *src, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> n)</td></tr>
121 <tr class="separator:memmove"><td class="memSeparator" colspan="2"> </td></tr>
122 <tr class="memitem:memset"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#memset">memset</a> (void *s, int <a class="el" href="sms_8h.html#c">c</a>, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> n) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#b">b</a></td></tr>
123 <tr class="separator:memset"><td class="memSeparator" colspan="2"> </td></tr>
124 <tr class="memitem:reverse"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#reverse">reverse</a> (char *s) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#b">b</a></td></tr>
125 <tr class="separator:reverse"><td class="memSeparator" colspan="2"> </td></tr>
126 <tr class="memitem:strcat"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#strcat">strcat</a> (char *s1, const char *s2)</td></tr>
127 <tr class="separator:strcat"><td class="memSeparator" colspan="2"> </td></tr>
128 <tr class="memitem:strlen"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#strlen">strlen</a> (const char *s) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#b">b</a></td></tr>
129 <tr class="separator:strlen"><td class="memSeparator" colspan="2"> </td></tr>
130 <tr class="memitem:strncat"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#strncat">strncat</a> (char *s1, const char *s2, int n)</td></tr>
131 <tr class="separator:strncat"><td class="memSeparator" colspan="2"> </td></tr>
132 <tr class="memitem:strncmp"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#strncmp">strncmp</a> (const char *s1, const char *s2, int n)</td></tr>
133 <tr class="separator:strncmp"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:strncpy"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#strncpy">strncpy</a> (char *s1, const char *s2, int n)</td></tr>
135 <tr class="separator:strncpy"><td class="memSeparator" colspan="2"> </td></tr>
136 <tr class="memitem:memcmp"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#memcmp">memcmp</a> (const void *buf1, const void *buf2, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> count) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
137 <tr class="separator:memcmp"><td class="memSeparator" colspan="2"> </td></tr>
138 </table><table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
140 Variables</h2></td></tr>
141 <tr class="memitem:c"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2sm83_2string_8h.html#c">c</a></td></tr>
142 <tr class="separator:c"><td class="memSeparator" colspan="2"> </td></tr>
143 </table>
144 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
145 <div class="textblock"><p >Generic string functions. </p>
146 </div><h2 class="groupheader">Function Documentation</h2>
147 <a id="strcpy" name="strcpy"></a>
148 <h2 class="memtitle"><span class="permalink"><a href="#strcpy">◆ </a></span>strcpy()</h2>
149
150 <div class="memitem">
151 <div class="memproto">
152 <table class="memname">
153 <tr>
154 <td class="memname">char * strcpy </td>
155 <td>(</td>
156 <td class="paramtype">char * </td>
157 <td class="paramname"><em>dest</em>, </td>
158 </tr>
159 <tr>
160 <td class="paramkey"></td>
161 <td></td>
162 <td class="paramtype">const char * </td>
163 <td class="paramname"><em>src</em> </td>
164 </tr>
165 <tr>
166 <td></td>
167 <td>)</td>
168 <td></td><td></td>
169 </tr>
170 </table>
171 </div><div class="memdoc">
172 <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>
173 <p >The strings may not overlap, and the destination string dest must be large enough to receive the copy.</p>
174 <dl class="params"><dt>Parameters</dt><dd>
175 <table class="params">
176 <tr><td class="paramname">dest</td><td>Array to copy into </td></tr>
177 <tr><td class="paramname">src</td><td>Array to copy from</td></tr>
178 </table>
179 </dd>
180 </dl>
181 <dl class="section return"><dt>Returns</dt><dd>A pointer to dest </dd></dl>
182
183 </div>
184 </div>
185 <a id="strcmp" name="strcmp"></a>
186 <h2 class="memtitle"><span class="permalink"><a href="#strcmp">◆ </a></span>strcmp()</h2>
187
188 <div class="memitem">
189 <div class="memproto">
190 <table class="memname">
191 <tr>
192 <td class="memname">int strcmp </td>
193 <td>(</td>
194 <td class="paramtype">const char * </td>
195 <td class="paramname"><em>s1</em>, </td>
196 </tr>
197 <tr>
198 <td class="paramkey"></td>
199 <td></td>
200 <td class="paramtype">const char * </td>
201 <td class="paramname"><em>s2</em> </td>
202 </tr>
203 <tr>
204 <td></td>
205 <td>)</td>
206 <td></td><td></td>
207 </tr>
208 </table>
209 </div><div class="memdoc">
210 <p >Compares strings</p>
211 <dl class="params"><dt>Parameters</dt><dd>
212 <table class="params">
213 <tr><td class="paramname">s1</td><td>First string to compare </td></tr>
214 <tr><td class="paramname">s2</td><td>Second string to compare</td></tr>
215 </table>
216 </dd>
217 </dl>
218 <p>Returns: </p><ul>
219 <li>> 0 if <b>s1</b> > <b>s2</b> </li>
220 <li>0 if <b>s1</b> == <b>s2</b> </li>
221 <li>< 0 if <b>s1</b> < <b>s2</b> </li>
222 </ul>
223
224 </div>
225 </div>
226 <a id="memcpy" name="memcpy"></a>
227 <h2 class="memtitle"><span class="permalink"><a href="#memcpy">◆ </a></span>memcpy()</h2>
228
229 <div class="memitem">
230 <div class="memproto">
231 <table class="memname">
232 <tr>
233 <td class="memname">void * memcpy </td>
234 <td>(</td>
235 <td class="paramtype">void * </td>
236 <td class="paramname"><em>dest</em>, </td>
237 </tr>
238 <tr>
239 <td class="paramkey"></td>
240 <td></td>
241 <td class="paramtype">const void * </td>
242 <td class="paramname"><em>src</em>, </td>
243 </tr>
244 <tr>
245 <td class="paramkey"></td>
246 <td></td>
247 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
248 <td class="paramname"><em>len</em> </td>
249 </tr>
250 <tr>
251 <td></td>
252 <td>)</td>
253 <td></td><td></td>
254 </tr>
255 </table>
256 </div><div class="memdoc">
257 <p >Copies n bytes from memory area src to memory area dest.</p>
258 <p >The memory areas may not overlap.</p>
259 <dl class="params"><dt>Parameters</dt><dd>
260 <table class="params">
261 <tr><td class="paramname">dest</td><td>Buffer to copy into </td></tr>
262 <tr><td class="paramname">src</td><td>Buffer to copy from </td></tr>
263 <tr><td class="paramname">len</td><td>Number of Bytes to copy </td></tr>
264 </table>
265 </dd>
266 </dl>
267
268 </div>
269 </div>
270 <a id="memmove" name="memmove"></a>
271 <h2 class="memtitle"><span class="permalink"><a href="#memmove">◆ </a></span>memmove()</h2>
272
273 <div class="memitem">
274 <div class="memproto">
275 <table class="memname">
276 <tr>
277 <td class="memname">void * memmove </td>
278 <td>(</td>
279 <td class="paramtype">void * </td>
280 <td class="paramname"><em>dest</em>, </td>
281 </tr>
282 <tr>
283 <td class="paramkey"></td>
284 <td></td>
285 <td class="paramtype">const void * </td>
286 <td class="paramname"><em>src</em>, </td>
287 </tr>
288 <tr>
289 <td class="paramkey"></td>
290 <td></td>
291 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
292 <td class="paramname"><em>n</em> </td>
293 </tr>
294 <tr>
295 <td></td>
296 <td>)</td>
297 <td></td><td></td>
298 </tr>
299 </table>
300 </div><div class="memdoc">
301 <p >Copies n bytes from memory area src to memory area dest, areas may overlap </p>
302
303 </div>
304 </div>
305 <a id="memset" name="memset"></a>
306 <h2 class="memtitle"><span class="permalink"><a href="#memset">◆ </a></span>memset()</h2>
307
308 <div class="memitem">
309 <div class="memproto">
310 <table class="memname">
311 <tr>
312 <td class="memname">void * memset </td>
313 <td>(</td>
314 <td class="paramtype">void * </td>
315 <td class="paramname"><em>s</em>, </td>
316 </tr>
317 <tr>
318 <td class="paramkey"></td>
319 <td></td>
320 <td class="paramtype">int </td>
321 <td class="paramname"><em>c</em>, </td>
322 </tr>
323 <tr>
324 <td class="paramkey"></td>
325 <td></td>
326 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
327 <td class="paramname"><em>n</em> </td>
328 </tr>
329 <tr>
330 <td></td>
331 <td>)</td>
332 <td></td><td></td>
333 </tr>
334 </table>
335 </div><div class="memdoc">
336 <p >Fills the memory region <b>s</b> with <b>n</b> bytes using value <b>c</b></p>
337 <dl class="params"><dt>Parameters</dt><dd>
338 <table class="params">
339 <tr><td class="paramname">s</td><td>Buffer to fill </td></tr>
340 <tr><td class="paramname">c</td><td>char value to fill with (truncated from int) </td></tr>
341 <tr><td class="paramname">n</td><td>Number of bytes to fill </td></tr>
342 </table>
343 </dd>
344 </dl>
345
346 </div>
347 </div>
348 <a id="reverse" name="reverse"></a>
349 <h2 class="memtitle"><span class="permalink"><a href="#reverse">◆ </a></span>reverse()</h2>
350
351 <div class="memitem">
352 <div class="memproto">
353 <table class="memname">
354 <tr>
355 <td class="memname">char * reverse </td>
356 <td>(</td>
357 <td class="paramtype">char * </td>
358 <td class="paramname"><em>s</em></td><td>)</td>
359 <td></td>
360 </tr>
361 </table>
362 </div><div class="memdoc">
363 <p >Reverses the characters in a string</p>
364 <dl class="params"><dt>Parameters</dt><dd>
365 <table class="params">
366 <tr><td class="paramname">s</td><td>Pointer to string to reverse.</td></tr>
367 </table>
368 </dd>
369 </dl>
370 <p>For example 'abcdefg' will become 'gfedcba'.</p>
371 <p >Banked as the string must be modifiable.</p>
372 <p >Returns: Pointer to <b>s</b> </p>
373
374 </div>
375 </div>
376 <a id="strcat" name="strcat"></a>
377 <h2 class="memtitle"><span class="permalink"><a href="#strcat">◆ </a></span>strcat()</h2>
378
379 <div class="memitem">
380 <div class="memproto">
381 <table class="memname">
382 <tr>
383 <td class="memname">char * strcat </td>
384 <td>(</td>
385 <td class="paramtype">char * </td>
386 <td class="paramname"><em>s1</em>, </td>
387 </tr>
388 <tr>
389 <td class="paramkey"></td>
390 <td></td>
391 <td class="paramtype">const char * </td>
392 <td class="paramname"><em>s2</em> </td>
393 </tr>
394 <tr>
395 <td></td>
396 <td>)</td>
397 <td></td><td></td>
398 </tr>
399 </table>
400 </div><div class="memdoc">
401 <p >Concatenate Strings. Appends string <b>s2</b> to the end of string <b>s1</b></p>
402 <dl class="params"><dt>Parameters</dt><dd>
403 <table class="params">
404 <tr><td class="paramname">s1</td><td>String to append onto </td></tr>
405 <tr><td class="paramname">s2</td><td>String to copy from</td></tr>
406 </table>
407 </dd>
408 </dl>
409 <p>For example 'abc' and 'def' will become 'abcdef'.</p>
410 <p >String <b>s1</b> must be large enough to store both <b>s1</b> and <b>s2</b>.</p>
411 <p >Returns: Pointer to <b>s1</b> </p>
412
413 </div>
414 </div>
415 <a id="strlen" name="strlen"></a>
416 <h2 class="memtitle"><span class="permalink"><a href="#strlen">◆ </a></span>strlen()</h2>
417
418 <div class="memitem">
419 <div class="memproto">
420 <table class="memname">
421 <tr>
422 <td class="memname">int strlen </td>
423 <td>(</td>
424 <td class="paramtype">const char * </td>
425 <td class="paramname"><em>s</em></td><td>)</td>
426 <td></td>
427 </tr>
428 </table>
429 </div><div class="memdoc">
430 <p >Calculates the length of a string</p>
431 <dl class="params"><dt>Parameters</dt><dd>
432 <table class="params">
433 <tr><td class="paramname">s</td><td>String to calculate length of</td></tr>
434 </table>
435 </dd>
436 </dl>
437 <p>Returns: Length of string not including the terminating ‘\0’ character. </p>
438
439 </div>
440 </div>
441 <a id="strncat" name="strncat"></a>
442 <h2 class="memtitle"><span class="permalink"><a href="#strncat">◆ </a></span>strncat()</h2>
443
444 <div class="memitem">
445 <div class="memproto">
446 <table class="memname">
447 <tr>
448 <td class="memname">char * strncat </td>
449 <td>(</td>
450 <td class="paramtype">char * </td>
451 <td class="paramname"><em>s1</em>, </td>
452 </tr>
453 <tr>
454 <td class="paramkey"></td>
455 <td></td>
456 <td class="paramtype">const char * </td>
457 <td class="paramname"><em>s2</em>, </td>
458 </tr>
459 <tr>
460 <td class="paramkey"></td>
461 <td></td>
462 <td class="paramtype">int </td>
463 <td class="paramname"><em>n</em> </td>
464 </tr>
465 <tr>
466 <td></td>
467 <td>)</td>
468 <td></td><td></td>
469 </tr>
470 </table>
471 </div><div class="memdoc">
472 <p >Concatenate at most <b>n</b> characters from string <b>s2</b> onto the end of <b>s1</b>.</p>
473 <dl class="params"><dt>Parameters</dt><dd>
474 <table class="params">
475 <tr><td class="paramname">s1</td><td>String to append onto </td></tr>
476 <tr><td class="paramname">s2</td><td>String to copy from </td></tr>
477 <tr><td class="paramname">n</td><td>Max number of characters to copy from <b>s2</b></td></tr>
478 </table>
479 </dd>
480 </dl>
481 <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>
482 <p >Returns: Pointer to <b>s1</b> </p>
483
484 </div>
485 </div>
486 <a id="strncmp" name="strncmp"></a>
487 <h2 class="memtitle"><span class="permalink"><a href="#strncmp">◆ </a></span>strncmp()</h2>
488
489 <div class="memitem">
490 <div class="memproto">
491 <table class="memname">
492 <tr>
493 <td class="memname">int strncmp </td>
494 <td>(</td>
495 <td class="paramtype">const char * </td>
496 <td class="paramname"><em>s1</em>, </td>
497 </tr>
498 <tr>
499 <td class="paramkey"></td>
500 <td></td>
501 <td class="paramtype">const char * </td>
502 <td class="paramname"><em>s2</em>, </td>
503 </tr>
504 <tr>
505 <td class="paramkey"></td>
506 <td></td>
507 <td class="paramtype">int </td>
508 <td class="paramname"><em>n</em> </td>
509 </tr>
510 <tr>
511 <td></td>
512 <td>)</td>
513 <td></td><td></td>
514 </tr>
515 </table>
516 </div><div class="memdoc">
517 <p >Compare strings (at most <b>n</b> characters):</p>
518 <dl class="params"><dt>Parameters</dt><dd>
519 <table class="params">
520 <tr><td class="paramname">s1</td><td>First string to compare </td></tr>
521 <tr><td class="paramname">s2</td><td>Second string to compare </td></tr>
522 <tr><td class="paramname">n</td><td>Max number of characters to compare</td></tr>
523 </table>
524 </dd>
525 </dl>
526 <p>Returns zero if the strings are identical, or non-zero if they are not (see below).</p>
527 <p >Returns: </p><ul>
528 <li>> 0 if <b>s1</b> > <b>s2</b> (at first non-matching byte) </li>
529 <li>0 if <b>s1</b> == <b>s2</b> </li>
530 <li>< 0 if <b>s1</b> < <b>s2</b> (at first non-matching byte) </li>
531 </ul>
532
533 </div>
534 </div>
535 <a id="strncpy" name="strncpy"></a>
536 <h2 class="memtitle"><span class="permalink"><a href="#strncpy">◆ </a></span>strncpy()</h2>
537
538 <div class="memitem">
539 <div class="memproto">
540 <table class="memname">
541 <tr>
542 <td class="memname">char * strncpy </td>
543 <td>(</td>
544 <td class="paramtype">char * </td>
545 <td class="paramname"><em>s1</em>, </td>
546 </tr>
547 <tr>
548 <td class="paramkey"></td>
549 <td></td>
550 <td class="paramtype">const char * </td>
551 <td class="paramname"><em>s2</em>, </td>
552 </tr>
553 <tr>
554 <td class="paramkey"></td>
555 <td></td>
556 <td class="paramtype">int </td>
557 <td class="paramname"><em>n</em> </td>
558 </tr>
559 <tr>
560 <td></td>
561 <td>)</td>
562 <td></td><td></td>
563 </tr>
564 </table>
565 </div><div class="memdoc">
566 <p >Copy <b>n</b> characters from string <b>s2</b> to <b>s1</b></p>
567 <dl class="params"><dt>Parameters</dt><dd>
568 <table class="params">
569 <tr><td class="paramname">s1</td><td>String to copy into </td></tr>
570 <tr><td class="paramname">s2</td><td>String to copy from </td></tr>
571 <tr><td class="paramname">n</td><td>Max number of characters to copy from <b>s2</b></td></tr>
572 </table>
573 </dd>
574 </dl>
575 <p>If <b>s2</b> is shorter than <b>n</b>, the remaining bytes in <b>s1</b> are filled with \0.</p>
576 <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>
577 <p >Returns: Pointer to <b>s1</b> </p>
578
579 </div>
580 </div>
581 <a id="memcmp" name="memcmp"></a>
582 <h2 class="memtitle"><span class="permalink"><a href="#memcmp">◆ </a></span>memcmp()</h2>
583
584 <div class="memitem">
585 <div class="memproto">
586 <table class="memname">
587 <tr>
588 <td class="memname">int memcmp </td>
589 <td>(</td>
590 <td class="paramtype">const void * </td>
591 <td class="paramname"><em>buf1</em>, </td>
592 </tr>
593 <tr>
594 <td class="paramkey"></td>
595 <td></td>
596 <td class="paramtype">const void * </td>
597 <td class="paramname"><em>buf2</em>, </td>
598 </tr>
599 <tr>
600 <td class="paramkey"></td>
601 <td></td>
602 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
603 <td class="paramname"><em>count</em> </td>
604 </tr>
605 <tr>
606 <td></td>
607 <td>)</td>
608 <td></td><td></td>
609 </tr>
610 </table>
611 </div><div class="memdoc">
612 <p >Compare up to <b>count</b> bytes in buffers <b>buf1</b> and <b>buf2</b></p>
613 <dl class="params"><dt>Parameters</dt><dd>
614 <table class="params">
615 <tr><td class="paramname">buf1</td><td>Pointer to First buffer to compare </td></tr>
616 <tr><td class="paramname">buf2</td><td>Pointer to Second buffer to compare </td></tr>
617 <tr><td class="paramname">count</td><td>Max number of bytes to compare</td></tr>
618 </table>
619 </dd>
620 </dl>
621 <p>Returns zero if the buffers are identical, or non-zero if they are not (see below).</p>
622 <p >Returns: </p><ul>
623 <li>> 0 if <b>buf1</b> > <b>buf2</b> (at first non-matching byte) </li>
624 <li>0 if <b>buf1</b> == <b>buf2</b> </li>
625 <li>< 0 if <b>buf1</b> < <b>buf2</b> (at first non-matching byte) </li>
626 </ul>
627
628 </div>
629 </div>
630 <h2 class="groupheader">Variable Documentation</h2>
631 <a id="c" name="c"></a>
632 <h2 class="memtitle"><span class="permalink"><a href="#c">◆ </a></span>c</h2>
633
634 <div class="memitem">
635 <div class="memproto">
636 <table class="memname">
637 <tr>
638 <td class="memname">void c</td>
639 </tr>
640 </table>
641 </div><div class="memdoc">
642
643 </div>
644 </div>
645 </div><!-- contents -->
646 </div><!-- doc-content -->
647 <!-- start footer part -->
648 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
649 <ul>
650 <li class="navelem"><a class="el" href="dir_8bd3092e915ccc8a773a74e0a10d4d15.html">gbdk-lib</a></li><li class="navelem"><a class="el" href="dir_a9f896cff747ba031115e41245385c17.html">include</a></li><li class="navelem"><a class="el" href="dir_9a64cddab8e5f6fe5be80d8f39cb6a1f.html">asm</a></li><li class="navelem"><a class="el" href="dir_7b7dd73d07fe37f50e5dcce289386fb1.html">sm83</a></li><li class="navelem"><a class="el" href="asm_2sm83_2string_8h.html">string.h</a></li>
651 <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
652 </ul>
653 </div>
654 </body>
655 </html>
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.