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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
|
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icalarray.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Libical API Documentation
 <span id="projectnumber">3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">icalarray.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An array of arbitrarily-sized elements which grows dynamically as elements are added.
<a href="#details">More...</a></p>
<p><a href="icalarray_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a 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="struct__icalarray.html">_icalarray</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 name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad36143942d5ac4709b68fff41615e598"><td class="memItemLeft" align="right" valign="top"><a id="ad36143942d5ac4709b68fff41615e598"></a>
typedef struct <a class="el" href="struct__icalarray.html">_icalarray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a></td></tr>
<tr class="memdesc:ad36143942d5ac4709b68fff41615e598"><td class="mdescLeft"> </td><td class="mdescRight">A struct representing an icalarray object. <br /></td></tr>
<tr class="separator:ad36143942d5ac4709b68fff41615e598"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9a11feb130b619af9dd7f4003d52d242"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array, const void *element)</td></tr>
<tr class="memdesc:a9a11feb130b619af9dd7f4003d52d242"><td class="mdescLeft"> </td><td class="mdescRight">Appends an element to an array. <a href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">More...</a><br /></td></tr>
<tr class="separator:a9a11feb130b619af9dd7f4003d52d242"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4bcd6fa2682deef8bdfd0d3b59be567"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#aa4bcd6fa2682deef8bdfd0d3b59be567">icalarray_copy</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array)</td></tr>
<tr class="memdesc:aa4bcd6fa2682deef8bdfd0d3b59be567"><td class="mdescLeft"> </td><td class="mdescRight">Copies an existing icalarray and its elements, creating a new one. <a href="icalarray_8h.html#aa4bcd6fa2682deef8bdfd0d3b59be567">More...</a><br /></td></tr>
<tr class="separator:aa4bcd6fa2682deef8bdfd0d3b59be567"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d76fb1a34690980421b6c82c40d5f9c"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array, size_t position)</td></tr>
<tr class="memdesc:a8d76fb1a34690980421b6c82c40d5f9c"><td class="mdescLeft"> </td><td class="mdescRight">Access an array element. <a href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">More...</a><br /></td></tr>
<tr class="separator:a8d76fb1a34690980421b6c82c40d5f9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a725724cdff58a12520abc7d6bfdf5e0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array)</td></tr>
<tr class="memdesc:a725724cdff58a12520abc7d6bfdf5e0f"><td class="mdescLeft"> </td><td class="mdescRight">Frees an array object and everything that it contains. <a href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">More...</a><br /></td></tr>
<tr class="separator:a725724cdff58a12520abc7d6bfdf5e0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0254b829a5b491bf42d19afa3b2d6f1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a> (size_t element_size, size_t increment_size)</td></tr>
<tr class="memdesc:a0254b829a5b491bf42d19afa3b2d6f1e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new icalarray object. <a href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">More...</a><br /></td></tr>
<tr class="separator:a0254b829a5b491bf42d19afa3b2d6f1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afeff7fd9edc32284b5fb34fb61ec8c0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#afeff7fd9edc32284b5fb34fb61ec8c0a">icalarray_remove_element_at</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array, size_t position)</td></tr>
<tr class="memdesc:afeff7fd9edc32284b5fb34fb61ec8c0a"><td class="mdescLeft"> </td><td class="mdescRight">Removes a given element from an array. <a href="icalarray_8h.html#afeff7fd9edc32284b5fb34fb61ec8c0a">More...</a><br /></td></tr>
<tr class="separator:afeff7fd9edc32284b5fb34fb61ec8c0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7552d72058960fe92eeae36531275913"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#a7552d72058960fe92eeae36531275913">icalarray_sort</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array, int(*compare)(const void *, const void *))</td></tr>
<tr class="memdesc:a7552d72058960fe92eeae36531275913"><td class="mdescLeft"> </td><td class="mdescRight">Sorts the elements of an icalarray using the given comparison function. <a href="icalarray_8h.html#a7552d72058960fe92eeae36531275913">More...</a><br /></td></tr>
<tr class="separator:a7552d72058960fe92eeae36531275913"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An array of arbitrarily-sized elements which grows dynamically as elements are added. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a9a11feb130b619af9dd7f4003d52d242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a11feb130b619af9dd7f4003d52d242">◆ </a></span>icalarray_append()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalarray_append </td>
<td>(</td>
<td class="paramtype"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td>
<td class="paramname"><em>array</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>element</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends an element to an array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array to append the element to </td></tr>
<tr><td class="paramname">element</td><td>The element to append</td></tr>
</table>
</dd>
</dl>
<p>Appends the given <em>element</em> to the <em>array</em>, reallocating and expanding the array as needed.</p>
<dl class="section user"><dt>Error handling</dt><dd>If <em>array</em> or <em>element</em> is <code>NULL</code>, using this function results in undefined behaviour (most likely a segfault).</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The <em>element</em> does not get consumed by the method, since it creates a copy of it</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new array</span></div>
<div class="line"><a class="code" href="struct__icalarray.html">icalarray</a> *array = <a class="code" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// append data to it</span></div>
<div class="line"><span class="keywordtype">int</span> data = 42;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &data);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// release array</span></div>
<div class="line"><a class="code" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</div>
<div class="ttc" id="aicalarray_8h_html_a0254b829a5b491bf42d19afa3b2d6f1e"><div class="ttname"><a href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a></div><div class="ttdeci">icalarray * icalarray_new(size_t element_size, size_t increment_size)</div><div class="ttdoc">Creates a new icalarray object.</div><div class="ttdef"><b>Definition:</b> icalarray.c:31</div></div>
<div class="ttc" id="aicalarray_8h_html_a725724cdff58a12520abc7d6bfdf5e0f"><div class="ttname"><a href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a></div><div class="ttdeci">void icalarray_free(icalarray *array)</div><div class="ttdoc">Frees an array object and everything that it contains.</div><div class="ttdef"><b>Definition:</b> icalarray.c:90</div></div>
<div class="ttc" id="aicalarray_8h_html_a9a11feb130b619af9dd7f4003d52d242"><div class="ttname"><a href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a></div><div class="ttdeci">void icalarray_append(icalarray *array, const void *element)</div><div class="ttdoc">Appends an element to an array.</div><div class="ttdef"><b>Definition:</b> icalarray.c:105</div></div>
<div class="ttc" id="astruct__icalarray_html"><div class="ttname"><a href="struct__icalarray.html">_icalarray</a></div><div class="ttdef"><b>Definition:</b> icalarray.h:36</div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="aa4bcd6fa2682deef8bdfd0d3b59be567"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4bcd6fa2682deef8bdfd0d3b59be567">◆ </a></span>icalarray_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a>* icalarray_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td>
<td class="paramname"><em>array</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies an existing icalarray and its elements, creating a new one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array to copy </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new array, holding all the elements of <em>array</em> </dd></dl>
<p>Creates a new icalarray object, copying all the existing elements from <em>array</em> as well as its properties (such as <em>element_size</em> and <em>increment_size</em>) over.</p>
<dl class="section user"><dt>Error handling</dt><dd>If <em>array</em> is <code>NULL</code>, this method will return <code>NULL</code>. If there was an error allocating memory while creating the copy, it will set <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a3ed4d866c28acaaaf99348b1ab27cd78">ICAL_ALLOCATION_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The created copy is owned by the caller of the function, and needs to be released with <a class="el" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f" title="Frees an array object and everything that it contains.">icalarray_free()</a> after it's no longer being used.</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new array</span></div>
<div class="line"><a class="code" href="struct__icalarray.html">icalarray</a> *array = <a class="code" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// fill array</span></div>
<div class="line"><span class="keywordtype">int</span> a = 4;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// create copy of array</span></div>
<div class="line"><a class="code" href="struct__icalarray.html">icalarray</a> *copy = <a class="code" href="icalarray_8h.html#aa4bcd6fa2682deef8bdfd0d3b59be567">icalarray_copy</a>(array);</div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(copy, 0) == a);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// release arrays</span></div>
<div class="line"><a class="code" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</div>
<div class="line"><a class="code" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(copy);</div>
<div class="ttc" id="aicalarray_8h_html_a8d76fb1a34690980421b6c82c40d5f9c"><div class="ttname"><a href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a></div><div class="ttdeci">void * icalarray_element_at(icalarray *array, size_t position)</div><div class="ttdoc">Access an array element.</div><div class="ttdef"><b>Definition:</b> icalarray.c:117</div></div>
<div class="ttc" id="aicalarray_8h_html_aa4bcd6fa2682deef8bdfd0d3b59be567"><div class="ttname"><a href="icalarray_8h.html#aa4bcd6fa2682deef8bdfd0d3b59be567">icalarray_copy</a></div><div class="ttdeci">icalarray * icalarray_copy(icalarray *array)</div><div class="ttdoc">Copies an existing icalarray and its elements, creating a new one.</div><div class="ttdef"><b>Definition:</b> icalarray.c:60</div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="a8d76fb1a34690980421b6c82c40d5f9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d76fb1a34690980421b6c82c40d5f9c">◆ </a></span>icalarray_element_at()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* icalarray_element_at </td>
<td>(</td>
<td class="paramtype"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td>
<td class="paramname"><em>array</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access an array element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array object in which the element is stored </td></tr>
<tr><td class="paramname">position</td><td>The position of the element to access in the array </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the element inside the array</dd></dl>
<p>Accesses an array element by returning a pointer to it, given an <em>array</em> and a valid element <em>position</em>.</p>
<dl class="section user"><dt>Error handling</dt><dd>If <em>array</em> is <code>NULL</code>, using this function results in undefined behaviour. If <em>position</em> is not a valid position in the array, using this function results in undefined behaviour.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The element is owned by the icalarray, it must not be freed by the user.</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new array</span></div>
<div class="line"><a class="code" href="struct__icalarray.html">icalarray</a> *array = <a class="code" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// fill array</span></div>
<div class="line"><span class="keywordtype">int</span> a = 4;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// access array element</span></div>
<div class="line"><span class="keywordtype">int</span> *element = <a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 0);</div>
<div class="line">assert(element != NULL);</div>
<div class="line">assert(*element == a);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// change array element</span></div>
<div class="line">*element = 14;</div>
<div class="line">assert(*icalarray_element(array) == 14);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// release memory</span></div>
<div class="line"><a class="code" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="a725724cdff58a12520abc7d6bfdf5e0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a725724cdff58a12520abc7d6bfdf5e0f">◆ </a></span>icalarray_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalarray_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td>
<td class="paramname"><em>array</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees an array object and everything that it contains. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array to release</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// creating an array</span></div>
<div class="line"><a class="code" href="struct__icalarray.html">icalarray</a> *array = <a class="code" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// releasing it</span></div>
<div class="line"><a class="code" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="a0254b829a5b491bf42d19afa3b2d6f1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0254b829a5b491bf42d19afa3b2d6f1e">◆ </a></span>icalarray_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a>* icalarray_new </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>element_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>increment_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new icalarray object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">element_size</td><td>The size of the elements to be held by the array </td></tr>
<tr><td class="paramname">increment_size</td><td>How many extra elements worth of space to allocate on expansion </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new icalarray object </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f" title="Frees an array object and everything that it contains.">icalarray_free()</a></dd></dl>
<p>Creates a new icalarray object. The parameter <em>element_size</em> determines the size of the elements that the array will hold (in bytes). The parameter <em>increment_size</em> determines how many extra elements to be allocated when expanding the array for performance reasons (expansions are expensive, since it involves copying all existing elements).</p>
<dl class="section user"><dt>Error handling</dt><dd>If <em>element_size</em> or <em>increment_size</em> is not at least 1, using the icalarray object results in undefined behaviour. If there is an error while creating the object, it returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a055394ffaf6701aa12491dc10767f07d">ICAL_NEWFAILED_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The returned icalarray object is owned by the caller of the function, and needs to be released properly after it's no longer needed with <a class="el" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f" title="Frees an array object and everything that it contains.">icalarray_free()</a>.</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new array</span></div>
<div class="line"><a class="code" href="struct__icalarray.html">icalarray</a> *array = <a class="code" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// use array</span></div>
<div class="line"><span class="keywordtype">int</span> a = 4;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 0) == a);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// release memory</span></div>
<div class="line"><a class="code" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="afeff7fd9edc32284b5fb34fb61ec8c0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afeff7fd9edc32284b5fb34fb61ec8c0a">◆ </a></span>icalarray_remove_element_at()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalarray_remove_element_at </td>
<td>(</td>
<td class="paramtype"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td>
<td class="paramname"><em>array</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a given element from an array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array from which to remove the element </td></tr>
<tr><td class="paramname">position</td><td>The position of the element to remove</td></tr>
</table>
</dd>
</dl>
<p>Removes the element at the given position from the array.</p>
<dl class="section user"><dt>Error handling</dt><dd>If <em>array</em> is <code>NULL</code>, using this function results in undefined behaviour. If the array is empty, using this function results in undefined behaviour. If the <em>position</em> is non-existent, it removes the last element.</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new array</span></div>
<div class="line"><a class="code" href="struct__icalarray.html">icalarray</a> *array = <a class="code" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 2);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// fill array</span></div>
<div class="line"><span class="keywordtype">int</span> data;</div>
<div class="line">data = 4;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div>
<div class="line">data = 9;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div>
<div class="line">data = 7;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div>
<div class="line">data = 10;</div>
<div class="line"><a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// check array</span></div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 0) == 4);</div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 1) == 9);</div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 2) == 7);</div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 3) == 10);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// remove the second element</span></div>
<div class="line"><a class="code" href="icalarray_8h.html#afeff7fd9edc32284b5fb34fb61ec8c0a">icalarray_remove_element_at</a>(array, 1);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// check array</span></div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 0) == 4);</div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 1) == 7);</div>
<div class="line">assert(*<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, 2) == 10);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// release array</span></div>
<div class="line"><a class="code" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</div>
<div class="ttc" id="aicalarray_8h_html_afeff7fd9edc32284b5fb34fb61ec8c0a"><div class="ttname"><a href="icalarray_8h.html#afeff7fd9edc32284b5fb34fb61ec8c0a">icalarray_remove_element_at</a></div><div class="ttdeci">void icalarray_remove_element_at(icalarray *array, size_t position)</div><div class="ttdoc">Removes a given element from an array.</div><div class="ttdef"><b>Definition:</b> icalarray.c:125</div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
<a id="a7552d72058960fe92eeae36531275913"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7552d72058960fe92eeae36531275913">◆ </a></span>icalarray_sort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalarray_sort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td>
<td class="paramname"><em>array</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(const void *, const void *) </td>
<td class="paramname"><em>compare</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sorts the elements of an icalarray using the given comparison function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array to sort </td></tr>
<tr><td class="paramname">compare</td><td>The comparison function to use</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Error handling</dt><dd>Passing <code>NULL</code> as either <em>array</em> or <em>compare</em> results in undefined behaviour.</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">int</span> compare_ints(<span class="keyword">const</span> <span class="keywordtype">void</span> *a, <span class="keyword">const</span> <span class="keywordtype">void</span> *b) {</div>
<div class="line"> <span class="keywordflow">return</span> *((<span class="keywordtype">int</span>*)a) - *((<span class="keywordtype">int</span>*)b);</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[]) {</div>
<div class="line"> <span class="keywordtype">int</span> numbers[] = {5, 2, 7, 4, 3, 1, 0, 8, 6, 9};</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="struct__icalarray.html">icalarray</a> *array = <a class="code" href="icalarray_8h.html#a0254b829a5b491bf42d19afa3b2d6f1e">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 3);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// fill array</span></div>
<div class="line"> <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < 10; i++) {</div>
<div class="line"> <a class="code" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &numbers[i]);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// sort array</span></div>
<div class="line"> <a class="code" href="icalarray_8h.html#a7552d72058960fe92eeae36531275913">icalarray_sort</a>(array, compare_ints);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// print numbers</span></div>
<div class="line"> <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < 10; i++) {</div>
<div class="line"> printf(<span class="stringliteral">"%i\n"</span>, *((<span class="keywordtype">int</span>*)<a class="code" href="icalarray_8h.html#a8d76fb1a34690980421b6c82c40d5f9c">icalarray_element_at</a>(array, i)));</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aicalarray_8h_html_a7552d72058960fe92eeae36531275913"><div class="ttname"><a href="icalarray_8h.html#a7552d72058960fe92eeae36531275913">icalarray_sort</a></div><div class="ttdeci">void icalarray_sort(icalarray *array, int(*compare)(const void *, const void *))</div><div class="ttdoc">Sorts the elements of an icalarray using the given comparison function.</div><div class="ttdef"><b>Definition:</b> icalarray.c:136</div></div>
</div><!-- fragment --> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
