gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/asm_2z80_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/z80/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_2z80_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> </div>
104 <div class="headertitle"><div class="title">string.h File Reference</div></div>
105 </div><!--header-->
106 <div class="contents">
107 <div class="textblock"><code>#include <<a class="el" href="asm_2z80_2types_8h_source.html">types.h</a>></code><br />
108 </div>
109 <p><a href="asm_2z80_2string_8h_source.html">Go to the source code of this file.</a></p>
110 <table class="memberdecls">
111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
112 Functions</h2></td></tr>
113 <tr class="memitem:strcpy"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#strcpy">strcpy</a> (char *dest, const char *src) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
114 <tr class="separator:strcpy"><td class="memSeparator" colspan="2"> </td></tr>
115 <tr class="memitem:strcmp"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#strcmp">strcmp</a> (const char *s1, const char *s2)</td></tr>
116 <tr class="separator:strcmp"><td class="memSeparator" colspan="2"> </td></tr>
117 <tr class="memitem:memcpy"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_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>
118 <tr class="separator:memcpy"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="memitem:memmove"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_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) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
120 <tr class="separator:memmove"><td class="memSeparator" colspan="2"> </td></tr>
121 <tr class="memitem:memset"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_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_2z80_2types_8h.html#Z88DK_CALLEE">Z88DK_CALLEE</a></td></tr>
122 <tr class="separator:memset"><td class="memSeparator" colspan="2"> </td></tr>
123 <tr class="memitem:reverse"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#reverse">reverse</a> (char *s) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
124 <tr class="separator:reverse"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:strcat"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#strcat">strcat</a> (char *s1, const char *s2) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
126 <tr class="separator:strcat"><td class="memSeparator" colspan="2"> </td></tr>
127 <tr class="memitem:strlen"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#strlen">strlen</a> (const char *s) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
128 <tr class="separator:strlen"><td class="memSeparator" colspan="2"> </td></tr>
129 <tr class="memitem:strncat"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#strncat">strncat</a> (char *s1, const char *s2, int n) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
130 <tr class="separator:strncat"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:strncmp"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#strncmp">strncmp</a> (const char *s1, const char *s2, int n) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
132 <tr class="separator:strncmp"><td class="memSeparator" colspan="2"> </td></tr>
133 <tr class="memitem:strncpy"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_2string_8h.html#strncpy">strncpy</a> (char *s1, const char *s2, int n) <a class="el" href="asm_2types_8h.html#NONBANKED">NONBANKED</a></td></tr>
134 <tr class="separator:strncpy"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:memcmp"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="asm_2z80_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_2z80_2types_8h.html#Z88DK_CALLEE">Z88DK_CALLEE</a></td></tr>
136 <tr class="separator:memcmp"><td class="memSeparator" colspan="2"> </td></tr>
137 </table>
138 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
139 <div class="textblock"><p >Generic string functions. </p>
140 </div><h2 class="groupheader">Function Documentation</h2>
141 <a id="strcpy" name="strcpy"></a>
142 <h2 class="memtitle"><span class="permalink"><a href="#strcpy">◆ </a></span>strcpy()</h2>
143
144 <div class="memitem">
145 <div class="memproto">
146 <table class="memname">
147 <tr>
148 <td class="memname">char * strcpy </td>
149 <td>(</td>
150 <td class="paramtype">char * </td>
151 <td class="paramname"><em>dest</em>, </td>
152 </tr>
153 <tr>
154 <td class="paramkey"></td>
155 <td></td>
156 <td class="paramtype">const char * </td>
157 <td class="paramname"><em>src</em> </td>
158 </tr>
159 <tr>
160 <td></td>
161 <td>)</td>
162 <td></td><td></td>
163 </tr>
164 </table>
165 </div><div class="memdoc">
166 <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>
167 <p >The strings may not overlap, and the destination string dest must be large enough to receive the copy.</p>
168 <dl class="params"><dt>Parameters</dt><dd>
169 <table class="params">
170 <tr><td class="paramname">dest</td><td>Array to copy into </td></tr>
171 <tr><td class="paramname">src</td><td>Array to copy from</td></tr>
172 </table>
173 </dd>
174 </dl>
175 <dl class="section return"><dt>Returns</dt><dd>A pointer to dest </dd></dl>
176
177 </div>
178 </div>
179 <a id="strcmp" name="strcmp"></a>
180 <h2 class="memtitle"><span class="permalink"><a href="#strcmp">◆ </a></span>strcmp()</h2>
181
182 <div class="memitem">
183 <div class="memproto">
184 <table class="memname">
185 <tr>
186 <td class="memname">int strcmp </td>
187 <td>(</td>
188 <td class="paramtype">const char * </td>
189 <td class="paramname"><em>s1</em>, </td>
190 </tr>
191 <tr>
192 <td class="paramkey"></td>
193 <td></td>
194 <td class="paramtype">const char * </td>
195 <td class="paramname"><em>s2</em> </td>
196 </tr>
197 <tr>
198 <td></td>
199 <td>)</td>
200 <td></td><td></td>
201 </tr>
202 </table>
203 </div><div class="memdoc">
204 <p >Compares strings</p>
205 <dl class="params"><dt>Parameters</dt><dd>
206 <table class="params">
207 <tr><td class="paramname">s1</td><td>First string to compare </td></tr>
208 <tr><td class="paramname">s2</td><td>Second string to compare</td></tr>
209 </table>
210 </dd>
211 </dl>
212 <p>Returns: </p><ul>
213 <li>> 0 if <b>s1</b> > <b>s2</b> </li>
214 <li>0 if <b>s1</b> == <b>s2</b> </li>
215 <li>< 0 if <b>s1</b> < <b>s2</b> </li>
216 </ul>
217
218 </div>
219 </div>
220 <a id="memcpy" name="memcpy"></a>
221 <h2 class="memtitle"><span class="permalink"><a href="#memcpy">◆ </a></span>memcpy()</h2>
222
223 <div class="memitem">
224 <div class="memproto">
225 <table class="memname">
226 <tr>
227 <td class="memname">void * memcpy </td>
228 <td>(</td>
229 <td class="paramtype">void * </td>
230 <td class="paramname"><em>dest</em>, </td>
231 </tr>
232 <tr>
233 <td class="paramkey"></td>
234 <td></td>
235 <td class="paramtype">const void * </td>
236 <td class="paramname"><em>src</em>, </td>
237 </tr>
238 <tr>
239 <td class="paramkey"></td>
240 <td></td>
241 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
242 <td class="paramname"><em>len</em> </td>
243 </tr>
244 <tr>
245 <td></td>
246 <td>)</td>
247 <td></td><td></td>
248 </tr>
249 </table>
250 </div><div class="memdoc">
251 <p >Copies n bytes from memory area src to memory area dest.</p>
252 <p >The memory areas may not overlap.</p>
253 <dl class="params"><dt>Parameters</dt><dd>
254 <table class="params">
255 <tr><td class="paramname">dest</td><td>Buffer to copy into </td></tr>
256 <tr><td class="paramname">src</td><td>Buffer to copy from </td></tr>
257 <tr><td class="paramname">len</td><td>Number of Bytes to copy </td></tr>
258 </table>
259 </dd>
260 </dl>
261
262 </div>
263 </div>
264 <a id="memmove" name="memmove"></a>
265 <h2 class="memtitle"><span class="permalink"><a href="#memmove">◆ </a></span>memmove()</h2>
266
267 <div class="memitem">
268 <div class="memproto">
269 <table class="memname">
270 <tr>
271 <td class="memname">void * memmove </td>
272 <td>(</td>
273 <td class="paramtype">void * </td>
274 <td class="paramname"><em>dest</em>, </td>
275 </tr>
276 <tr>
277 <td class="paramkey"></td>
278 <td></td>
279 <td class="paramtype">const void * </td>
280 <td class="paramname"><em>src</em>, </td>
281 </tr>
282 <tr>
283 <td class="paramkey"></td>
284 <td></td>
285 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
286 <td class="paramname"><em>n</em> </td>
287 </tr>
288 <tr>
289 <td></td>
290 <td>)</td>
291 <td></td><td></td>
292 </tr>
293 </table>
294 </div><div class="memdoc">
295 <p >Copies n bytes from memory area src to memory area dest, areas may overlap </p>
296
297 </div>
298 </div>
299 <a id="memset" name="memset"></a>
300 <h2 class="memtitle"><span class="permalink"><a href="#memset">◆ </a></span>memset()</h2>
301
302 <div class="memitem">
303 <div class="memproto">
304 <table class="memname">
305 <tr>
306 <td class="memname">void * memset </td>
307 <td>(</td>
308 <td class="paramtype">void * </td>
309 <td class="paramname"><em>s</em>, </td>
310 </tr>
311 <tr>
312 <td class="paramkey"></td>
313 <td></td>
314 <td class="paramtype">int </td>
315 <td class="paramname"><em>c</em>, </td>
316 </tr>
317 <tr>
318 <td class="paramkey"></td>
319 <td></td>
320 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
321 <td class="paramname"><em>n</em> </td>
322 </tr>
323 <tr>
324 <td></td>
325 <td>)</td>
326 <td></td><td></td>
327 </tr>
328 </table>
329 </div><div class="memdoc">
330 <p >Fills the memory region <b>s</b> with <b>n</b> bytes using value <b>c</b></p>
331 <dl class="params"><dt>Parameters</dt><dd>
332 <table class="params">
333 <tr><td class="paramname">s</td><td>Buffer to fill </td></tr>
334 <tr><td class="paramname">c</td><td>char value to fill with (truncated from int) </td></tr>
335 <tr><td class="paramname">n</td><td>Number of bytes to fill </td></tr>
336 </table>
337 </dd>
338 </dl>
339
340 </div>
341 </div>
342 <a id="reverse" name="reverse"></a>
343 <h2 class="memtitle"><span class="permalink"><a href="#reverse">◆ </a></span>reverse()</h2>
344
345 <div class="memitem">
346 <div class="memproto">
347 <table class="memname">
348 <tr>
349 <td class="memname">char * reverse </td>
350 <td>(</td>
351 <td class="paramtype">char * </td>
352 <td class="paramname"><em>s</em></td><td>)</td>
353 <td></td>
354 </tr>
355 </table>
356 </div><div class="memdoc">
357 <p >Reverses the characters in a string</p>
358 <dl class="params"><dt>Parameters</dt><dd>
359 <table class="params">
360 <tr><td class="paramname">s</td><td>Pointer to string to reverse.</td></tr>
361 </table>
362 </dd>
363 </dl>
364 <p>For example 'abcdefg' will become 'gfedcba'.</p>
365 <p >Banked as the string must be modifiable.</p>
366 <p >Returns: Pointer to <b>s</b> </p>
367
368 </div>
369 </div>
370 <a id="strcat" name="strcat"></a>
371 <h2 class="memtitle"><span class="permalink"><a href="#strcat">◆ </a></span>strcat()</h2>
372
373 <div class="memitem">
374 <div class="memproto">
375 <table class="memname">
376 <tr>
377 <td class="memname">char * strcat </td>
378 <td>(</td>
379 <td class="paramtype">char * </td>
380 <td class="paramname"><em>s1</em>, </td>
381 </tr>
382 <tr>
383 <td class="paramkey"></td>
384 <td></td>
385 <td class="paramtype">const char * </td>
386 <td class="paramname"><em>s2</em> </td>
387 </tr>
388 <tr>
389 <td></td>
390 <td>)</td>
391 <td></td><td></td>
392 </tr>
393 </table>
394 </div><div class="memdoc">
395 <p >Concatenate Strings. Appends string <b>s2</b> to the end of string <b>s1</b></p>
396 <dl class="params"><dt>Parameters</dt><dd>
397 <table class="params">
398 <tr><td class="paramname">s1</td><td>String to append onto </td></tr>
399 <tr><td class="paramname">s2</td><td>String to copy from</td></tr>
400 </table>
401 </dd>
402 </dl>
403 <p>For example 'abc' and 'def' will become 'abcdef'.</p>
404 <p >String <b>s1</b> must be large enough to store both <b>s1</b> and <b>s2</b>.</p>
405 <p >Returns: Pointer to <b>s1</b> </p>
406
407 </div>
408 </div>
409 <a id="strlen" name="strlen"></a>
410 <h2 class="memtitle"><span class="permalink"><a href="#strlen">◆ </a></span>strlen()</h2>
411
412 <div class="memitem">
413 <div class="memproto">
414 <table class="memname">
415 <tr>
416 <td class="memname">int strlen </td>
417 <td>(</td>
418 <td class="paramtype">const char * </td>
419 <td class="paramname"><em>s</em></td><td>)</td>
420 <td></td>
421 </tr>
422 </table>
423 </div><div class="memdoc">
424 <p >Calculates the length of a string</p>
425 <dl class="params"><dt>Parameters</dt><dd>
426 <table class="params">
427 <tr><td class="paramname">s</td><td>String to calculate length of</td></tr>
428 </table>
429 </dd>
430 </dl>
431 <p>Returns: Length of string not including the terminating ‘\0’ character. </p>
432
433 </div>
434 </div>
435 <a id="strncat" name="strncat"></a>
436 <h2 class="memtitle"><span class="permalink"><a href="#strncat">◆ </a></span>strncat()</h2>
437
438 <div class="memitem">
439 <div class="memproto">
440 <table class="memname">
441 <tr>
442 <td class="memname">char * strncat </td>
443 <td>(</td>
444 <td class="paramtype">char * </td>
445 <td class="paramname"><em>s1</em>, </td>
446 </tr>
447 <tr>
448 <td class="paramkey"></td>
449 <td></td>
450 <td class="paramtype">const char * </td>
451 <td class="paramname"><em>s2</em>, </td>
452 </tr>
453 <tr>
454 <td class="paramkey"></td>
455 <td></td>
456 <td class="paramtype">int </td>
457 <td class="paramname"><em>n</em> </td>
458 </tr>
459 <tr>
460 <td></td>
461 <td>)</td>
462 <td></td><td></td>
463 </tr>
464 </table>
465 </div><div class="memdoc">
466 <p >Concatenate at most <b>n</b> characters from string <b>s2</b> onto the end of <b>s1</b>.</p>
467 <dl class="params"><dt>Parameters</dt><dd>
468 <table class="params">
469 <tr><td class="paramname">s1</td><td>String to append onto </td></tr>
470 <tr><td class="paramname">s2</td><td>String to copy from </td></tr>
471 <tr><td class="paramname">n</td><td>Max number of characters to copy from <b>s2</b></td></tr>
472 </table>
473 </dd>
474 </dl>
475 <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>
476 <p >Returns: Pointer to <b>s1</b> </p>
477
478 </div>
479 </div>
480 <a id="strncmp" name="strncmp"></a>
481 <h2 class="memtitle"><span class="permalink"><a href="#strncmp">◆ </a></span>strncmp()</h2>
482
483 <div class="memitem">
484 <div class="memproto">
485 <table class="memname">
486 <tr>
487 <td class="memname">int strncmp </td>
488 <td>(</td>
489 <td class="paramtype">const char * </td>
490 <td class="paramname"><em>s1</em>, </td>
491 </tr>
492 <tr>
493 <td class="paramkey"></td>
494 <td></td>
495 <td class="paramtype">const char * </td>
496 <td class="paramname"><em>s2</em>, </td>
497 </tr>
498 <tr>
499 <td class="paramkey"></td>
500 <td></td>
501 <td class="paramtype">int </td>
502 <td class="paramname"><em>n</em> </td>
503 </tr>
504 <tr>
505 <td></td>
506 <td>)</td>
507 <td></td><td></td>
508 </tr>
509 </table>
510 </div><div class="memdoc">
511 <p >Compare strings (at most n characters):</p>
512 <dl class="params"><dt>Parameters</dt><dd>
513 <table class="params">
514 <tr><td class="paramname">s1</td><td>First string to compare </td></tr>
515 <tr><td class="paramname">s2</td><td>Second string to compare </td></tr>
516 <tr><td class="paramname">n</td><td>Max number of characters to compare</td></tr>
517 </table>
518 </dd>
519 </dl>
520 <p>Returns: </p><ul>
521 <li>> 0 if <b>s1</b> > <b>s2</b> </li>
522 <li>0 if <b>s1</b> == <b>s2</b> </li>
523 <li>< 0 if <b>s1</b> < <b>s2</b> </li>
524 </ul>
525
526 </div>
527 </div>
528 <a id="strncpy" name="strncpy"></a>
529 <h2 class="memtitle"><span class="permalink"><a href="#strncpy">◆ </a></span>strncpy()</h2>
530
531 <div class="memitem">
532 <div class="memproto">
533 <table class="memname">
534 <tr>
535 <td class="memname">char * strncpy </td>
536 <td>(</td>
537 <td class="paramtype">char * </td>
538 <td class="paramname"><em>s1</em>, </td>
539 </tr>
540 <tr>
541 <td class="paramkey"></td>
542 <td></td>
543 <td class="paramtype">const char * </td>
544 <td class="paramname"><em>s2</em>, </td>
545 </tr>
546 <tr>
547 <td class="paramkey"></td>
548 <td></td>
549 <td class="paramtype">int </td>
550 <td class="paramname"><em>n</em> </td>
551 </tr>
552 <tr>
553 <td></td>
554 <td>)</td>
555 <td></td><td></td>
556 </tr>
557 </table>
558 </div><div class="memdoc">
559 <p >Copy <b>n</b> characters from string <b>s2</b> to <b>s1</b></p>
560 <dl class="params"><dt>Parameters</dt><dd>
561 <table class="params">
562 <tr><td class="paramname">s1</td><td>String to copy into </td></tr>
563 <tr><td class="paramname">s2</td><td>String to copy from </td></tr>
564 <tr><td class="paramname">n</td><td>Max number of characters to copy from <b>s2</b></td></tr>
565 </table>
566 </dd>
567 </dl>
568 <p>If <b>s2</b> is shorter than <b>n</b>, the remaining bytes in <b>s1</b> are filled with \0.</p>
569 <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>
570 <p >Returns: Pointer to <b>s1</b> </p>
571
572 </div>
573 </div>
574 <a id="memcmp" name="memcmp"></a>
575 <h2 class="memtitle"><span class="permalink"><a href="#memcmp">◆ </a></span>memcmp()</h2>
576
577 <div class="memitem">
578 <div class="memproto">
579 <table class="memname">
580 <tr>
581 <td class="memname">int memcmp </td>
582 <td>(</td>
583 <td class="paramtype">const void * </td>
584 <td class="paramname"><em>buf1</em>, </td>
585 </tr>
586 <tr>
587 <td class="paramkey"></td>
588 <td></td>
589 <td class="paramtype">const void * </td>
590 <td class="paramname"><em>buf2</em>, </td>
591 </tr>
592 <tr>
593 <td class="paramkey"></td>
594 <td></td>
595 <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> </td>
596 <td class="paramname"><em>count</em> </td>
597 </tr>
598 <tr>
599 <td></td>
600 <td>)</td>
601 <td></td><td></td>
602 </tr>
603 </table>
604 </div><div class="memdoc">
605 <p >Compares buffers</p>
606 <dl class="params"><dt>Parameters</dt><dd>
607 <table class="params">
608 <tr><td class="paramname">buf1</td><td>First buffer to compare </td></tr>
609 <tr><td class="paramname">buf2</td><td>Second buffer to compare </td></tr>
610 <tr><td class="paramname">count</td><td>Buffer length</td></tr>
611 </table>
612 </dd>
613 </dl>
614 <p>Returns: </p><ul>
615 <li>> 0 if <b>buf1</b> > <b>buf2</b> </li>
616 <li>0 if <b>buf1</b> == <b>buf2</b> </li>
617 <li>< 0 if <b>buf1</b> < <b>buf2</b> </li>
618 </ul>
619
620 </div>
621 </div>
622 </div><!-- contents -->
623 </div><!-- doc-content -->
624 <!-- start footer part -->
625 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
626 <ul>
627 <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_68ce43fa3f06453c3f79ef8becebb3b2.html">z80</a></li><li class="navelem"><a class="el" href="asm_2z80_2string_8h.html">string.h</a></li>
628 <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>
629 </ul>
630 </div>
631 </body>
632 </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.