diff options
Diffstat (limited to 'apidocs/icalarray_8h.html')
| -rw-r--r-- | apidocs/icalarray_8h.html | 173 |
1 files changed, 87 insertions, 86 deletions
diff --git a/apidocs/icalarray_8h.html b/apidocs/icalarray_8h.html index 48014615..e115af38 100644 --- a/apidocs/icalarray_8h.html +++ b/apidocs/icalarray_8h.html @@ -2,8 +2,8 @@ <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=11"/> -<meta name="generator" content="Doxygen 1.9.3"/> +<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"/> @@ -19,9 +19,10 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr id="projectrow"> - <td id="projectalign"> - <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.1</span> + <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> @@ -29,22 +30,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.3 --> +<!-- Generated by Doxygen 1.9.1 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ -var searchBox = new SearchBox("searchBox", "search",'Search','.html'); +/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +/* @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> +/* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -70,7 +70,8 @@ $(function() { <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 class="headertitle"> +<div class="title">icalarray.h File Reference</div> </div> </div><!--header--> <div class="contents"> @@ -79,35 +80,35 @@ $(function() { <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 id="nested-classes" name="nested-classes"></a> +<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 id="typedef-members" name="typedef-members"></a> +<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" name="ad36143942d5ac4709b68fff41615e598"></a> -typedef struct <a class="el" href="struct__icalarray.html">_icalarray</a> </td><td class="memItemRight" valign="bottom"><b>icalarray</b></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 id="func-members" name="func-members"></a> +<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:a4e7b1165ef6a6a63e7d67dedfb789dc8"><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#a4e7b1165ef6a6a63e7d67dedfb789dc8">icalarray_copy</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array)</td></tr> -<tr class="memdesc:a4e7b1165ef6a6a63e7d67dedfb789dc8"><td class="mdescLeft"> </td><td class="mdescRight">Copies an existing icalarray and its elements, creating a new one. <a href="icalarray_8h.html#a4e7b1165ef6a6a63e7d67dedfb789dc8">More...</a><br /></td></tr> -<tr class="separator:a4e7b1165ef6a6a63e7d67dedfb789dc8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2f12e8a9e9d70d80ad8a621b7d52af96"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *array, size_t position)</td></tr> -<tr class="memdesc:a2f12e8a9e9d70d80ad8a621b7d52af96"><td class="mdescLeft"> </td><td class="mdescRight">Access an array element. <a href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">More...</a><br /></td></tr> -<tr class="separator:a2f12e8a9e9d70d80ad8a621b7d52af96"><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:aeab98d02907573525bccdd548c6f8f1d"><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#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a> (size_t element_size, size_t increment_size)</td></tr> -<tr class="memdesc:aeab98d02907573525bccdd548c6f8f1d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new icalarray object. <a href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">More...</a><br /></td></tr> -<tr class="separator:aeab98d02907573525bccdd548c6f8f1d"><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> @@ -116,9 +117,9 @@ Functions</h2></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 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" name="a9a11feb130b619af9dd7f4003d52d242"></a> +<a id="a9a11feb130b619af9dd7f4003d52d242"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9a11feb130b619af9dd7f4003d52d242">◆ </a></span>icalarray_append()</h2> <div class="memitem"> @@ -156,30 +157,30 @@ Functions</h2></td></tr> <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 hl_struct" href="struct__icalarray.html">icalarray</a> *array = <a class="code hl_function" href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &data);</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 hl_function" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</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:91</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:106</div></div> -<div class="ttc" id="aicalarray_8h_html_aeab98d02907573525bccdd548c6f8f1d"><div class="ttname"><a href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">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:25</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:30</div></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="a4e7b1165ef6a6a63e7d67dedfb789dc8" name="a4e7b1165ef6a6a63e7d67dedfb789dc8"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a4e7b1165ef6a6a63e7d67dedfb789dc8">◆ </a></span>icalarray_copy()</h2> +<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 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> @@ -200,33 +201,33 @@ Functions</h2></td></tr> <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 hl_struct" href="struct__icalarray.html">icalarray</a> *array = <a class="code hl_function" href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</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 hl_struct" href="struct__icalarray.html">icalarray</a> *copy = <a class="code hl_function" href="icalarray_8h.html#a4e7b1165ef6a6a63e7d67dedfb789dc8">icalarray_copy</a>(array);</div> -<div class="line">assert(*<a class="code hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(copy, 0) == a);</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 hl_function" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</div> -<div class="line"><a class="code hl_function" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(copy);</div> -<div class="ttc" id="aicalarray_8h_html_a2f12e8a9e9d70d80ad8a621b7d52af96"><div class="ttname"><a href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">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:122</div></div> -<div class="ttc" id="aicalarray_8h_html_a4e7b1165ef6a6a63e7d67dedfb789dc8"><div class="ttname"><a href="icalarray_8h.html#a4e7b1165ef6a6a63e7d67dedfb789dc8">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:54</div></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="a2f12e8a9e9d70d80ad8a621b7d52af96" name="a2f12e8a9e9d70d80ad8a621b7d52af96"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a2f12e8a9e9d70d80ad8a621b7d52af96">◆ </a></span>icalarray_element_at()</h2> +<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 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> @@ -258,14 +259,14 @@ Functions</h2></td></tr> <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 hl_struct" href="struct__icalarray.html">icalarray</a> *array = <a class="code hl_function" href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</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 hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 0);</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> @@ -274,12 +275,12 @@ Functions</h2></td></tr> <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 hl_function" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</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" name="a725724cdff58a12520abc7d6bfdf5e0f"></a> +<a id="a725724cdff58a12520abc7d6bfdf5e0f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a725724cdff58a12520abc7d6bfdf5e0f">◆ </a></span>icalarray_free()</h2> <div class="memitem"> @@ -303,22 +304,22 @@ Functions</h2></td></tr> </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 hl_struct" href="struct__icalarray.html">icalarray</a> *array = <a class="code hl_function" href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</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 hl_function" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</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="aeab98d02907573525bccdd548c6f8f1d" name="aeab98d02907573525bccdd548c6f8f1d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aeab98d02907573525bccdd548c6f8f1d">◆ </a></span>icalarray_new()</h2> +<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 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> @@ -351,20 +352,20 @@ Functions</h2></td></tr> <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 hl_struct" href="struct__icalarray.html">icalarray</a> *array = <a class="code hl_function" href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 1);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</div> -<div class="line">assert(*<a class="code hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 0) == a);</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 hl_function" href="icalarray_8h.html#a725724cdff58a12520abc7d6bfdf5e0f">icalarray_free</a>(array);</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" name="afeff7fd9edc32284b5fb34fb61ec8c0a"></a> +<a id="afeff7fd9edc32284b5fb34fb61ec8c0a"></a> <h2 class="memtitle"><span class="permalink"><a href="#afeff7fd9edc32284b5fb34fb61ec8c0a">◆ </a></span>icalarray_remove_element_at()</h2> <div class="memitem"> @@ -401,41 +402,41 @@ Functions</h2></td></tr> <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 hl_struct" href="struct__icalarray.html">icalarray</a> *array = <a class="code hl_function" href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 2);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &a);</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 hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 0) == 4);</div> -<div class="line">assert(*<a class="code hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 1) == 9);</div> -<div class="line">assert(*<a class="code hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 2) == 7);</div> -<div class="line">assert(*<a class="code hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 3) == 10);</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 hl_function" href="icalarray_8h.html#afeff7fd9edc32284b5fb34fb61ec8c0a">icalarray_remove_element_at</a>(array, 1);</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 hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 0) == 4);</div> -<div class="line">assert(*<a class="code hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 1) == 7);</div> -<div class="line">assert(*<a class="code hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 2) == 10);</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 hl_function" 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:130</div></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" name="a7552d72058960fe92eeae36531275913"></a> +<a id="a7552d72058960fe92eeae36531275913"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7552d72058960fe92eeae36531275913">◆ </a></span>icalarray_sort()</h2> <div class="memitem"> @@ -477,24 +478,24 @@ Functions</h2></td></tr> <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 hl_struct" href="struct__icalarray.html">icalarray</a> *array = <a class="code hl_function" href="icalarray_8h.html#aeab98d02907573525bccdd548c6f8f1d">icalarray_new</a>(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), 3);</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 hl_function" href="icalarray_8h.html#a9a11feb130b619af9dd7f4003d52d242">icalarray_append</a>(array, &numbers[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 hl_function" href="icalarray_8h.html#a7552d72058960fe92eeae36531275913">icalarray_sort</a>(array, compare_ints);</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 hl_function" href="icalarray_8h.html#a2f12e8a9e9d70d80ad8a621b7d52af96">icalarray_element_at</a>(array, 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:162</div></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> @@ -502,7 +503,7 @@ Functions</h2></td></tr> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Sat Jun 25 2022 08:55:43 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.3 +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> |