-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgroup__sg__str.html
429 lines (411 loc) · 21.9 KB
/
group__sg__str.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
<!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.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Sagui library: String</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="sagui.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">Sagui library<span id="projectnumber"> v3.5.0</span>
</div>
<div id="projectbrief">Cross-platform library which helps to develop web servers or frameworks.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">String<div class="ingroups"><a class="el" href="group__sg__api.html">API reference</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsg__str.html">sg_str</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9f96b237d9719679f1486965134097ad"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structsg__str.html">sg_str</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#ga9f96b237d9719679f1486965134097ad">sg_str_new</a> (void) __attribute__((malloc))</td></tr>
<tr class="separator:ga9f96b237d9719679f1486965134097ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaae1e56717404fde09aea8639bbfa8d80"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#gaae1e56717404fde09aea8639bbfa8d80">sg_str_free</a> (struct <a class="el" href="structsg__str.html">sg_str</a> *str)</td></tr>
<tr class="separator:gaae1e56717404fde09aea8639bbfa8d80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2e75bfd4c36ffd580b437296a8e015bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#ga2e75bfd4c36ffd580b437296a8e015bd">sg_str_write</a> (struct <a class="el" href="structsg__str.html">sg_str</a> *str, const char *val, size_t len)</td></tr>
<tr class="separator:ga2e75bfd4c36ffd580b437296a8e015bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5074de99d01422caa8d3dd0b9e6d80ea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#ga5074de99d01422caa8d3dd0b9e6d80ea">sg_str_printf_va</a> (struct <a class="el" href="structsg__str.html">sg_str</a> *str, const char *fmt, va_list ap)</td></tr>
<tr class="separator:ga5074de99d01422caa8d3dd0b9e6d80ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca6e4ba7d52ece0ee313519c48336811"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#gaca6e4ba7d52ece0ee313519c48336811">sg_str_printf</a> (struct <a class="el" href="structsg__str.html">sg_str</a> *str, const char *fmt,...) __attribute__((format(printf</td></tr>
<tr class="separator:gaca6e4ba7d52ece0ee313519c48336811"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga26c8c498ef411d6876453f2220574fcd"><td class="memItemLeft" align="right" valign="top">int const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#ga26c8c498ef411d6876453f2220574fcd">sg_str_content</a> (struct <a class="el" href="structsg__str.html">sg_str</a> *str)</td></tr>
<tr class="separator:ga26c8c498ef411d6876453f2220574fcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5fee7ead6e4e5140800e387bed90066a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#ga5fee7ead6e4e5140800e387bed90066a">sg_str_length</a> (struct <a class="el" href="structsg__str.html">sg_str</a> *str)</td></tr>
<tr class="separator:ga5fee7ead6e4e5140800e387bed90066a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ebdf6cc438564501d00e5dcc7e6b656"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sg__str.html#ga0ebdf6cc438564501d00e5dcc7e6b656">sg_str_clear</a> (struct <a class="el" href="structsg__str.html">sg_str</a> *str)</td></tr>
<tr class="separator:ga0ebdf6cc438564501d00e5dcc7e6b656"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>String handle and its related functions. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9f96b237d9719679f1486965134097ad" name="ga9f96b237d9719679f1486965134097ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f96b237d9719679f1486965134097ad">◆ </a></span>sg_str_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structsg__str.html">sg_str</a> * sg_str_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new zero-initialized string handle. </p><dl class="section return"><dt>Returns</dt><dd>String handle. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">NULL</td><td>If no memory space is available. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example_httpreq_form_8c-example.html#a5">example_httpreq_form.c</a>, <a class="el" href="example_httpuplds_8c-example.html#a4">example_httpuplds.c</a>, <a class="el" href="example_router_srv_8c-example.html#a6">example_router_srv.c</a>, and <a class="el" href="example_str_8c-example.html#a1">example_str.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaae1e56717404fde09aea8639bbfa8d80" name="gaae1e56717404fde09aea8639bbfa8d80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae1e56717404fde09aea8639bbfa8d80">◆ </a></span>sg_str_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sg_str_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsg__str.html">sg_str</a> * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees the string handle previously allocated by <a class="el" href="group__sg__str.html#ga9f96b237d9719679f1486965134097ad">sg_str_new()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Pointer of the string handle to be freed. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example_httpreq_form_8c-example.html#a10">example_httpreq_form.c</a>, <a class="el" href="example_httpuplds_8c-example.html#a14">example_httpuplds.c</a>, <a class="el" href="example_router_srv_8c-example.html#a10">example_router_srv.c</a>, and <a class="el" href="example_str_8c-example.html#a4">example_str.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga2e75bfd4c36ffd580b437296a8e015bd" name="ga2e75bfd4c36ffd580b437296a8e015bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2e75bfd4c36ffd580b437296a8e015bd">◆ </a></span>sg_str_write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sg_str_write </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsg__str.html">sg_str</a> * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a null-terminated string to the string handle <b><code class="paramname">str</code></b>. All strings previously written are kept. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>String handle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>String to be written. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Length of the string to be written. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">EINVAL</td><td>Invalid argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5074de99d01422caa8d3dd0b9e6d80ea" name="ga5074de99d01422caa8d3dd0b9e6d80ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5074de99d01422caa8d3dd0b9e6d80ea">◆ </a></span>sg_str_printf_va()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sg_str_printf_va </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsg__str.html">sg_str</a> * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"><em>ap</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints a null-terminated formatted string from the argument list to the string handle <b><code class="paramname">str</code></b>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>String handle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Formatted string (following the same <a href="https://linux.die.net/man/3/printf"><code>printf()</code></a> format specification). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ap</td><td>Arguments list (handled by <a href="https://linux.die.net/man/3/va_start"><code>va_start()</code></a>/ <a href="https://linux.die.net/man/3/va_end"><code>va_end()</code></a>). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">EINVAL</td><td>Invalid argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaca6e4ba7d52ece0ee313519c48336811" name="gaca6e4ba7d52ece0ee313519c48336811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca6e4ba7d52ece0ee313519c48336811">◆ </a></span>sg_str_printf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sg_str_printf </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsg__str.html">sg_str</a> * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints a null-terminated formatted string to the string handle <b><code class="paramname">str</code></b>. All strings previously written are kept. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>String handle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>Formatted string (following the same <a href="https://linux.die.net/man/3/printf"><code>printf()</code></a> format specification). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">...</td><td>Additional arguments (following the same <a href="https://linux.die.net/man/3/printf"><code>printf()</code></a> arguments specification). </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">EINVAL</td><td>Invalid argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example_httpreq_form_8c-example.html#a7">example_httpreq_form.c</a>, <a class="el" href="example_httpuplds_8c-example.html#a5">example_httpuplds.c</a>, <a class="el" href="example_router_srv_8c-example.html#a8">example_router_srv.c</a>, and <a class="el" href="example_str_8c-example.html#a2">example_str.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga26c8c498ef411d6876453f2220574fcd" name="ga26c8c498ef411d6876453f2220574fcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26c8c498ef411d6876453f2220574fcd">◆ </a></span>sg_str_content()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int const char * sg_str_content </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsg__str.html">sg_str</a> * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the null-terminated string content from the string handle <b><code class="paramname">str</code></b>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>String handle. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Content as a null-terminated string. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">NULL</td><td>If the <b><code class="paramname">str</code></b> is null and set the <code>errno</code> to <code>EINVAL</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example_httpreq_form_8c-example.html#a9">example_httpreq_form.c</a>, <a class="el" href="example_httpreq_payload_8c-example.html#a5">example_httpreq_payload.c</a>, <a class="el" href="example_httpuplds_8c-example.html#a11">example_httpuplds.c</a>, <a class="el" href="example_router_srv_8c-example.html#a9">example_router_srv.c</a>, and <a class="el" href="example_str_8c-example.html#a3">example_str.c</a>.</dd>
</dl>
</div>
</div>
<a id="ga5fee7ead6e4e5140800e387bed90066a" name="ga5fee7ead6e4e5140800e387bed90066a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5fee7ead6e4e5140800e387bed90066a">◆ </a></span>sg_str_length()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t sg_str_length </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsg__str.html">sg_str</a> * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the total string length from the handle <b><code class="paramname">str</code></b>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>String handle. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Total string length. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">EINVAL</td><td>Invalid argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga0ebdf6cc438564501d00e5dcc7e6b656" name="ga0ebdf6cc438564501d00e5dcc7e6b656"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ebdf6cc438564501d00e5dcc7e6b656">◆ </a></span>sg_str_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sg_str_clear </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsg__str.html">sg_str</a> * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears all existing content in the string handle <b><code class="paramname">str</code></b>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>String handle. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">EINVAL</td><td>Invalid argument. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example_httpuplds_8c-example.html#a12">example_httpuplds.c</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 14 2024 15:11:38 for Sagui library by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>