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