diff options
author | Allen Winter <allen.winter@kdab.com> | 2022-10-06 14:47:43 -0400 |
---|---|---|
committer | Allen Winter <allen.winter@kdab.com> | 2022-10-06 14:47:43 -0400 |
commit | 89a67caf2c463900bf0d8fa552b21e5ac4bf0f78 (patch) | |
tree | 85248809364062d4e325660c1ed2efc82492b9d6 /apidocs/icalparser_8h.html | |
parent | d428294888871b513716279103fed26f920924e8 (diff) | |
download | libical-git-gh-pages.tar.gz |
update apidoxgh-pages
Diffstat (limited to 'apidocs/icalparser_8h.html')
-rw-r--r-- | apidocs/icalparser_8h.html | 211 |
1 files changed, 106 insertions, 105 deletions
diff --git a/apidocs/icalparser_8h.html b/apidocs/icalparser_8h.html index e7d517a8..7ad4b182 100644 --- a/apidocs/icalparser_8h.html +++ b/apidocs/icalparser_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: icalparser.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="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> - <div class="headertitle"><div class="title">icalparser.h File Reference</div></div> + <div class="headertitle"> +<div class="title">icalparser.h File Reference</div> </div> </div><!--header--> <div class="contents"> @@ -79,18 +80,18 @@ $(function() { <p><a href="icalparser_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="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:a9332da05cc4922f68ae2b07f442c06fa"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structicalparser__impl.html">icalparser_impl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a></td></tr> <tr class="separator:a9332da05cc4922f68ae2b07f442c06fa"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a69220c4ae4e2d8b576334ac8049f6a32"><td class="memItemLeft" align="right" valign="top"><a id="a69220c4ae4e2d8b576334ac8049f6a32" name="a69220c4ae4e2d8b576334ac8049f6a32"></a> +<tr class="memitem:a0917f8ab0a302751de31c6e1172fad6f"><td class="memItemLeft" align="right" valign="top"><a id="a0917f8ab0a302751de31c6e1172fad6f"></a> typedef char *(* </td><td class="memItemRight" valign="bottom"><b>icalparser_line_gen_func</b>) (char *s, size_t size, void *d)</td></tr> -<tr class="separator:a69220c4ae4e2d8b576334ac8049f6a32"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af8b34b2ce5d2982022e34e8a0ef32be0"><td class="memItemLeft" align="right" valign="top"><a id="af8b34b2ce5d2982022e34e8a0ef32be0" name="af8b34b2ce5d2982022e34e8a0ef32be0"></a> +<tr class="separator:a0917f8ab0a302751de31c6e1172fad6f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af8b34b2ce5d2982022e34e8a0ef32be0"><td class="memItemLeft" align="right" valign="top"><a id="af8b34b2ce5d2982022e34e8a0ef32be0"></a> typedef enum <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> </td><td class="memItemRight" valign="bottom"><b>icalparser_state</b></td></tr> <tr class="separator:af8b34b2ce5d2982022e34e8a0ef32be0"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:aeec42cd09dd789c699d7b6741cbec3e7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> { <br />   <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> @@ -104,45 +105,45 @@ Enumerations</h2></td></tr> <tr class="memdesc:aeec42cd09dd789c699d7b6741cbec3e7"><td class="mdescLeft"> </td><td class="mdescRight">Represents the current state of the parser. <a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">More...</a><br /></td></tr> <tr class="separator:aeec42cd09dd789c699d7b6741cbec3e7"><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:a987113ea951dc55e37a764af168caaca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca">icalparser_add_line</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, char *str)</td></tr> -<tr class="memdesc:a987113ea951dc55e37a764af168caaca"><td class="mdescLeft"> </td><td class="mdescRight">Adds a single line to be parsed by the icalparser. <a href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca">More...</a><br /></td></tr> -<tr class="separator:a987113ea951dc55e37a764af168caaca"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa6e4c9c494345c51adf49a7e30255fb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#aa6e4c9c494345c51adf49a7e30255fb7">icalparser_clean</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser)</td></tr> -<tr class="memdesc:aa6e4c9c494345c51adf49a7e30255fb7"><td class="mdescLeft"> </td><td class="mdescRight">Cleans out an icalparser and returns whatever it has parsed so far. <a href="icalparser_8h.html#aa6e4c9c494345c51adf49a7e30255fb7">More...</a><br /></td></tr> -<tr class="separator:aa6e4c9c494345c51adf49a7e30255fb7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1138735cde70554bcdfc17dc8a595a6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a">icalparser_add_line</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, char *str)</td></tr> +<tr class="memdesc:a1138735cde70554bcdfc17dc8a595a6a"><td class="mdescLeft"> </td><td class="mdescRight">Adds a single line to be parsed by the icalparser. <a href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a">More...</a><br /></td></tr> +<tr class="separator:a1138735cde70554bcdfc17dc8a595a6a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa184343e374e5a201d8079df827597b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#aa184343e374e5a201d8079df827597b2">icalparser_clean</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser)</td></tr> +<tr class="memdesc:aa184343e374e5a201d8079df827597b2"><td class="mdescLeft"> </td><td class="mdescRight">Cleans out an icalparser and returns whatever it has parsed so far. <a href="icalparser_8h.html#aa184343e374e5a201d8079df827597b2">More...</a><br /></td></tr> +<tr class="separator:aa184343e374e5a201d8079df827597b2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser)</td></tr> <tr class="memdesc:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="mdescLeft"> </td><td class="mdescRight">Frees an icalparser object. <a href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">More...</a><br /></td></tr> <tr class="separator:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ada2de638b68de5146ae860631709f4a3"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">icalparser_get_line</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> -<tr class="memdesc:ada2de638b68de5146ae860631709f4a3"><td class="mdescLeft"> </td><td class="mdescRight">Given a line generator function, returns a single iCal content line. <a href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">More...</a><br /></td></tr> -<tr class="separator:ada2de638b68de5146ae860631709f4a3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1e9b165c1aa2ba82605bcccadf85f74c"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a1e9b165c1aa2ba82605bcccadf85f74c">icalparser_get_line</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> +<tr class="memdesc:a1e9b165c1aa2ba82605bcccadf85f74c"><td class="mdescLeft"> </td><td class="mdescRight">Given a line generator function, returns a single iCal content line. <a href="icalparser_8h.html#a1e9b165c1aa2ba82605bcccadf85f74c">More...</a><br /></td></tr> +<tr class="separator:a1e9b165c1aa2ba82605bcccadf85f74c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9a27d19ac53219bb65aeb9a031dbf027"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser)</td></tr> <tr class="memdesc:a9a27d19ac53219bb65aeb9a031dbf027"><td class="mdescLeft"> </td><td class="mdescRight">Returns current state of the icalparser. <a href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">More...</a><br /></td></tr> <tr class="separator:a9a27d19ac53219bb65aeb9a031dbf027"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9848e4dc69f814f49a5ece028c43be57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a> (void)</td></tr> -<tr class="memdesc:a9848e4dc69f814f49a5ece028c43be57"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new icalparser. <a href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">More...</a><br /></td></tr> -<tr class="separator:a9848e4dc69f814f49a5ece028c43be57"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a00330df647417bb017a7daaaffafddec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec">icalparser_parse</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> -<tr class="memdesc:a00330df647417bb017a7daaaffafddec"><td class="mdescLeft"> </td><td class="mdescRight">Message oriented parsing. <a href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec">More...</a><br /></td></tr> -<tr class="separator:a00330df647417bb017a7daaaffafddec"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a5e1268344c61e44a0ec18085688f07fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd">icalparser_parse_string</a> (const char *str)</td></tr> -<tr class="memdesc:a5e1268344c61e44a0ec18085688f07fd"><td class="mdescLeft"> </td><td class="mdescRight">Parses a string and returns the parsed icalcomponent. <a href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd">More...</a><br /></td></tr> -<tr class="separator:a5e1268344c61e44a0ec18085688f07fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3a7a45307a9ff90ec23d632501c0bd00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a> (void)</td></tr> +<tr class="memdesc:a3a7a45307a9ff90ec23d632501c0bd00"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new icalparser. <a href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">More...</a><br /></td></tr> +<tr class="separator:a3a7a45307a9ff90ec23d632501c0bd00"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aab80e10c3636d6476bc4920ae72d4b70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#aab80e10c3636d6476bc4920ae72d4b70">icalparser_parse</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> +<tr class="memdesc:aab80e10c3636d6476bc4920ae72d4b70"><td class="mdescLeft"> </td><td class="mdescRight">Message oriented parsing. <a href="icalparser_8h.html#aab80e10c3636d6476bc4920ae72d4b70">More...</a><br /></td></tr> +<tr class="separator:aab80e10c3636d6476bc4920ae72d4b70"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a966f6fd4bc931c06b2c596daeadb692f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a966f6fd4bc931c06b2c596daeadb692f">icalparser_parse_string</a> (const char *str)</td></tr> +<tr class="memdesc:a966f6fd4bc931c06b2c596daeadb692f"><td class="mdescLeft"> </td><td class="mdescRight">Parses a string and returns the parsed icalcomponent. <a href="icalparser_8h.html#a966f6fd4bc931c06b2c596daeadb692f">More...</a><br /></td></tr> +<tr class="separator:a966f6fd4bc931c06b2c596daeadb692f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aae6d08b4084610e225621a25dddd7689"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, void *data)</td></tr> <tr class="memdesc:aae6d08b4084610e225621a25dddd7689"><td class="mdescLeft"> </td><td class="mdescRight">Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'. <a href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">More...</a><br /></td></tr> <tr class="separator:aae6d08b4084610e225621a25dddd7689"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6429fdd3d61babc95a3851d78c16ae66"><td class="memItemLeft" align="right" valign="top"><a id="a6429fdd3d61babc95a3851d78c16ae66" name="a6429fdd3d61babc95a3851d78c16ae66"></a> +<tr class="memitem:a7c0eb0a99b21f94b4d5009cd660382e7"><td class="memItemLeft" align="right" valign="top"><a id="a7c0eb0a99b21f94b4d5009cd660382e7"></a> char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_line_generator</b> (char *out, size_t buf_size, void *d)</td></tr> -<tr class="separator:a6429fdd3d61babc95a3851d78c16ae66"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="separator:a7c0eb0a99b21f94b4d5009cd660382e7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p >Line-oriented parsing. </p> -<p >This file provides methods to parse iCalendar-formatted data into the structures provided by this library.</p> -<dl class="section user"><dt>Usage</dt><dd>Create a new parser via icalparser_new_parser(), then add lines one at a time with <a class="el" href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca" title="Adds a single line to be parsed by the icalparser.">icalparser_add_line()</a>. <a class="el" href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca" title="Adds a single line to be parsed by the icalparser.">icalparser_add_line()</a> will return non-zero when it has finished with a component. </dd></dl> +<div class="textblock"><p>Line-oriented parsing. </p> +<p>This file provides methods to parse iCalendar-formatted data into the structures provided by this library.</p> +<dl class="section user"><dt>Usage</dt><dd>Create a new parser via icalparser_new_parser(), then add lines one at a time with <a class="el" href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a" title="Adds a single line to be parsed by the icalparser.">icalparser_add_line()</a>. <a class="el" href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a" title="Adds a single line to be parsed by the icalparser.">icalparser_add_line()</a> will return non-zero when it has finished with a component. </dd></dl> </div><h2 class="groupheader">Typedef Documentation</h2> -<a id="a9332da05cc4922f68ae2b07f442c06fa" name="a9332da05cc4922f68ae2b07f442c06fa"></a> +<a id="a9332da05cc4922f68ae2b07f442c06fa"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9332da05cc4922f68ae2b07f442c06fa">◆ </a></span>icalparser</h2> <div class="memitem"> @@ -153,12 +154,12 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </tr> </table> </div><div class="memdoc"> -<p >Implementation of the icalparser struct, which holds the state for the current parsing operation. </p> +<p>Implementation of the icalparser struct, which holds the state for the current parsing operation. </p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> -<a id="aeec42cd09dd789c699d7b6741cbec3e7" name="aeec42cd09dd789c699d7b6741cbec3e7"></a> +<a id="aeec42cd09dd789c699d7b6741cbec3e7"></a> <h2 class="memtitle"><span class="permalink"><a href="#aeec42cd09dd789c699d7b6741cbec3e7">◆ </a></span>icalparser_state</h2> <div class="memitem"> @@ -172,29 +173,29 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <p>Represents the current state of the parser. </p> <table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8" name="aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"></a>ICALPARSER_ERROR </td><td class="fielddoc"><p >An error occurred while parsing. </p> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"></a>ICALPARSER_ERROR </td><td class="fielddoc"><p>An error occurred while parsing. </p> </td></tr> -<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090" name="aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090"></a>ICALPARSER_SUCCESS </td><td class="fielddoc"><p >Parsing was successful. </p> +<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090"></a>ICALPARSER_SUCCESS </td><td class="fielddoc"><p>Parsing was successful. </p> </td></tr> -<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e" name="aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e"></a>ICALPARSER_BEGIN_COMP </td><td class="fielddoc"><p >Currently parsing the begin of a component. </p> +<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e"></a>ICALPARSER_BEGIN_COMP </td><td class="fielddoc"><p>Currently parsing the begin of a component. </p> </td></tr> -<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2" name="aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2"></a>ICALPARSER_END_COMP </td><td class="fielddoc"><p >Currently parsing the end of the component. </p> +<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2"></a>ICALPARSER_END_COMP </td><td class="fielddoc"><p>Currently parsing the end of the component. </p> </td></tr> -<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2" name="aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2"></a>ICALPARSER_IN_PROGRESS </td><td class="fielddoc"><p >Parsing is currently in progress. </p> +<tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2"></a>ICALPARSER_IN_PROGRESS </td><td class="fielddoc"><p>Parsing is currently in progress. </p> </td></tr> </table> </div> </div> <h2 class="groupheader">Function Documentation</h2> -<a id="a987113ea951dc55e37a764af168caaca" name="a987113ea951dc55e37a764af168caaca"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a987113ea951dc55e37a764af168caaca">◆ </a></span>icalparser_add_line()</h2> +<a id="a1138735cde70554bcdfc17dc8a595a6a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1138735cde70554bcdfc17dc8a595a6a">◆ </a></span>icalparser_add_line()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * icalparser_add_line </td> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalparser_add_line </td> <td>(</td> <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> <td class="paramname"><em>parser</em>, </td> @@ -222,7 +223,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>When this was the last line of the component to be parsed, it returns the icalcomponent, otherwise it returns <code>NULL</code>. </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec" title="Message oriented parsing.">icalparser_parse()</a></dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparser_8h.html#aab80e10c3636d6476bc4920ae72d4b70" title="Message oriented parsing.">icalparser_parse()</a></dd></dl> <dl class="section user"><dt>Error handling</dt><dd><ul> <li>If <em>parser</em> is <code>NULL</code>, 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#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>.</li> <li>If <em>line</em> is empty, if returns <code>NULL</code></li> @@ -240,19 +241,19 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="line">{</div> <div class="line"> <span class="keywordtype">char</span>* line;</div> <div class="line"> FILE* stream;</div> -<div class="line"> <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *component;</div> +<div class="line"> <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component;</div> <div class="line"> </div> -<div class="line"> <a class="code hl_struct" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code hl_function" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a>();</div> +<div class="line"> <a class="code" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code" href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a>();</div> <div class="line"> stream = fopen(argv[1],<span class="stringliteral">"r"</span>);</div> <div class="line"> </div> -<div class="line"> <a class="code hl_function" href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a>(parser, stream);</div> +<div class="line"> <a class="code" href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a>(parser, stream);</div> <div class="line"> </div> <div class="line"> <span class="keywordflow">do</span>{</div> <div class="line"> <span class="comment">// get a single content line</span></div> -<div class="line"> line = <a class="code hl_function" href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">icalparser_get_line</a>(parser, read_stream);</div> +<div class="line"> line = <a class="code" href="icalparser_8h.html#a1e9b165c1aa2ba82605bcccadf85f74c">icalparser_get_line</a>(parser, read_stream);</div> <div class="line"> </div> <div class="line"> <span class="comment">// add that line to the parser</span></div> -<div class="line"> c = <a class="code hl_function" href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca">icalparser_add_line</a>(parser,line);</div> +<div class="line"> c = <a class="code" href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a">icalparser_add_line</a>(parser,line);</div> <div class="line"> </div> <div class="line"> <span class="comment">// once we parsed a component, print it</span></div> <div class="line"> <span class="keywordflow">if</span> (c != 0) {</div> @@ -261,27 +262,27 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="line"> }</div> <div class="line"> } <span class="keywordflow">while</span> (line != 0);</div> <div class="line"> </div> -<div class="line"> <a class="code hl_function" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> +<div class="line"> <a class="code" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> <div class="line">}</div> -<div class="ttc" id="aicalparser_8h_html_a1cb8b8678b781d3d2ede0fbce613b90d"><div class="ttname"><a href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a></div><div class="ttdeci">void icalparser_free(icalparser *parser)</div><div class="ttdoc">Frees an icalparser object.</div><div class="ttdef"><b>Definition:</b> icalparser.c:104</div></div> -<div class="ttc" id="aicalparser_8h_html_a9848e4dc69f814f49a5ece028c43be57"><div class="ttname"><a href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a></div><div class="ttdeci">icalparser * icalparser_new(void)</div><div class="ttdoc">Creates a new icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:81</div></div> -<div class="ttc" id="aicalparser_8h_html_a987113ea951dc55e37a764af168caaca"><div class="ttname"><a href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca">icalparser_add_line</a></div><div class="ttdeci">icalcomponent * icalparser_add_line(icalparser *parser, char *str)</div><div class="ttdoc">Adds a single line to be parsed by the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:682</div></div> -<div class="ttc" id="aicalparser_8h_html_aae6d08b4084610e225621a25dddd7689"><div class="ttname"><a href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a></div><div class="ttdeci">void icalparser_set_gen_data(icalparser *parser, void *data)</div><div class="ttdoc">Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.</div><div class="ttdef"><b>Definition:</b> icalparser.c:121</div></div> -<div class="ttc" id="aicalparser_8h_html_ada2de638b68de5146ae860631709f4a3"><div class="ttname"><a href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">icalparser_get_line</a></div><div class="ttdeci">char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Given a line generator function, returns a single iCal content line.</div><div class="ttdef"><b>Definition:</b> icalparser.c:467</div></div> -<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:28</div></div> -<div class="ttc" id="astructicalparser__impl_html"><div class="ttname"><a href="structicalparser__impl.html">icalparser_impl</a></div><div class="ttdef"><b>Definition:</b> icalparser.c:32</div></div> +<div class="ttc" id="aicalparser_8h_html_a1138735cde70554bcdfc17dc8a595a6a"><div class="ttname"><a href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a">icalparser_add_line</a></div><div class="ttdeci">icalcomponent * icalparser_add_line(icalparser *parser, char *str)</div><div class="ttdoc">Adds a single line to be parsed by the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:691</div></div> +<div class="ttc" id="aicalparser_8h_html_a1cb8b8678b781d3d2ede0fbce613b90d"><div class="ttname"><a href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a></div><div class="ttdeci">void icalparser_free(icalparser *parser)</div><div class="ttdoc">Frees an icalparser object.</div><div class="ttdef"><b>Definition:</b> icalparser.c:121</div></div> +<div class="ttc" id="aicalparser_8h_html_a1e9b165c1aa2ba82605bcccadf85f74c"><div class="ttname"><a href="icalparser_8h.html#a1e9b165c1aa2ba82605bcccadf85f74c">icalparser_get_line</a></div><div class="ttdeci">char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Given a line generator function, returns a single iCal content line.</div><div class="ttdef"><b>Definition:</b> icalparser.c:480</div></div> +<div class="ttc" id="aicalparser_8h_html_a3a7a45307a9ff90ec23d632501c0bd00"><div class="ttname"><a href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a></div><div class="ttdeci">icalparser * icalparser_new(void)</div><div class="ttdoc">Creates a new icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:99</div></div> +<div class="ttc" id="aicalparser_8h_html_aae6d08b4084610e225621a25dddd7689"><div class="ttname"><a href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a></div><div class="ttdeci">void icalparser_set_gen_data(icalparser *parser, void *data)</div><div class="ttdoc">Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.</div><div class="ttdef"><b>Definition:</b> icalparser.c:138</div></div> +<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:36</div></div> +<div class="ttc" id="astructicalparser__impl_html"><div class="ttname"><a href="structicalparser__impl.html">icalparser_impl</a></div><div class="ttdef"><b>Definition:</b> icalparser.c:51</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="aa6e4c9c494345c51adf49a7e30255fb7" name="aa6e4c9c494345c51adf49a7e30255fb7"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aa6e4c9c494345c51adf49a7e30255fb7">◆ </a></span>icalparser_clean()</h2> +<a id="aa184343e374e5a201d8079df827597b2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa184343e374e5a201d8079df827597b2">◆ </a></span>icalparser_clean()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * icalparser_clean </td> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalparser_clean </td> <td>(</td> <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> <td class="paramname"><em>parser</em></td><td>)</td> @@ -304,7 +305,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </div> </div> -<a id="a1cb8b8678b781d3d2ede0fbce613b90d" name="a1cb8b8678b781d3d2ede0fbce613b90d"></a> +<a id="a1cb8b8678b781d3d2ede0fbce613b90d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1cb8b8678b781d3d2ede0fbce613b90d">◆ </a></span>icalparser_free()</h2> <div class="memitem"> @@ -327,23 +328,23 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </table> </dd> </dl> -<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code hl_struct" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code hl_function" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a>();</div> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code" href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// use parser ...</span></div> <div class="line"> </div> -<div class="line"><a class="code hl_function" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> +<div class="line"><a class="code" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="ada2de638b68de5146ae860631709f4a3" name="ada2de638b68de5146ae860631709f4a3"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ada2de638b68de5146ae860631709f4a3">◆ </a></span>icalparser_get_line()</h2> +<a id="a1e9b165c1aa2ba82605bcccadf85f74c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1e9b165c1aa2ba82605bcccadf85f74c">◆ </a></span>icalparser_get_line()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">char * icalparser_get_line </td> + <td class="memname">char* icalparser_get_line </td> <td>(</td> <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> <td class="paramname"><em>parser</em>, </td> @@ -375,7 +376,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </div> </div> -<a id="a9a27d19ac53219bb65aeb9a031dbf027" name="a9a27d19ac53219bb65aeb9a031dbf027"></a> +<a id="a9a27d19ac53219bb65aeb9a031dbf027"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9a27d19ac53219bb65aeb9a031dbf027">◆ </a></span>icalparser_get_state()</h2> <div class="memitem"> @@ -399,30 +400,30 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The current state of the icalparser, as an <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7" title="Represents the current state of the parser.">icalparser_state</a></dd></dl> -<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code hl_struct" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code hl_function" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a>();</div> +<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code" href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// use icalparser...</span></div> <div class="line"> </div> -<div class="line"><span class="keywordflow">if</span>(<a class="code hl_function" href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a>(parser) == <a class="code hl_enumvalue" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a>) {</div> +<div class="line"><span class="keywordflow">if</span>(<a class="code" href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a>(parser) == <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a>) {</div> <div class="line"> <span class="comment">// handle error</span></div> <div class="line">} <span class="keywordflow">else</span> {</div> <div class="line"> <span class="comment">// ...</span></div> <div class="line">}</div> -<div class="ttc" id="aicalparser_8h_html_a9a27d19ac53219bb65aeb9a031dbf027"><div class="ttname"><a href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a></div><div class="ttdeci">icalparser_state icalparser_get_state(icalparser *parser)</div><div class="ttdoc">Returns current state of the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1238</div></div> -<div class="ttc" id="aicalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a></div><div class="ttdeci">@ ICALPARSER_ERROR</div><div class="ttdef"><b>Definition:</b> icalparser.h:49</div></div> +<div class="ttc" id="aicalparser_8h_html_a9a27d19ac53219bb65aeb9a031dbf027"><div class="ttname"><a href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a></div><div class="ttdeci">icalparser_state icalparser_get_state(icalparser *parser)</div><div class="ttdoc">Returns current state of the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1243</div></div> +<div class="ttc" id="aicalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a></div><div class="ttdeci">@ ICALPARSER_ERROR</div><div class="ttdef"><b>Definition:</b> icalparser.h:58</div></div> </div><!-- fragment --></dd></dl> <p>icalparser_free(parser); </p> </div> </div> -<a id="a9848e4dc69f814f49a5ece028c43be57" name="a9848e4dc69f814f49a5ece028c43be57"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a9848e4dc69f814f49a5ece028c43be57">◆ </a></span>icalparser_new()</h2> +<a id="a3a7a45307a9ff90ec23d632501c0bd00"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3a7a45307a9ff90ec23d632501c0bd00">◆ </a></span>icalparser_new()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * icalparser_new </td> + <td class="memname"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a>* icalparser_new </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> @@ -436,24 +437,24 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <dl class="section user"><dt>Error handling</dt><dd>On error, 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>All icalparser objects created with this function need to be freed using the <a class="el" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d" title="Frees an icalparser object.">icalparser_free()</a> function.</dd></dl> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new parser</span></div> -<div class="line"><a class="code hl_struct" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code hl_function" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a>();</div> +<div class="line"><a class="code" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code" href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// do something with it...</span></div> <div class="line"> </div> <div class="line"><span class="comment">// free parser</span></div> -<div class="line"><a class="code hl_function" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> +<div class="line"><a class="code" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a00330df647417bb017a7daaaffafddec" name="a00330df647417bb017a7daaaffafddec"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a00330df647417bb017a7daaaffafddec">◆ </a></span>icalparser_parse()</h2> +<a id="aab80e10c3636d6476bc4920ae72d4b70"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aab80e10c3636d6476bc4920ae72d4b70">◆ </a></span>icalparser_parse()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * icalparser_parse </td> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalparser_parse </td> <td>(</td> <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> <td class="paramname"><em>parser</em>, </td> @@ -481,7 +482,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The parsed icalcomponent </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd" title="Parses a string and returns the parsed icalcomponent.">icalparser_parse_string()</a></dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparser_8h.html#a966f6fd4bc931c06b2c596daeadb692f" title="Parses a string and returns the parsed icalcomponent.">icalparser_parse_string()</a></dd></dl> <p>Reads an icalcomponent using the supplied <em>line_gen_func</em>, returning the parsed component (or <code>NULL</code> on error).</p> <dl class="section user"><dt>Error handling</dt><dd><ul> <li>If <em>parser</em> is <code>NULL</code>, 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#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>.</li> @@ -500,35 +501,35 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="line">{</div> <div class="line"> <span class="keywordtype">char</span>* line;</div> <div class="line"> FILE* stream;</div> -<div class="line"> <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *component;</div> +<div class="line"> <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component;</div> <div class="line"> </div> -<div class="line"> <a class="code hl_struct" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code hl_function" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a>();</div> +<div class="line"> <a class="code" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code" href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a>();</div> <div class="line"> stream = fopen(argv[1],<span class="stringliteral">"r"</span>);</div> <div class="line"> </div> -<div class="line"> <a class="code hl_function" href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a>(parser, stream);</div> +<div class="line"> <a class="code" href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a>(parser, stream);</div> <div class="line"> </div> <div class="line"> <span class="comment">// use the parse method to parse the input data</span></div> -<div class="line"> component = <a class="code hl_function" href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec">icalparser_parse</a>(parser, read_stream);</div> +<div class="line"> component = <a class="code" href="icalparser_8h.html#aab80e10c3636d6476bc4920ae72d4b70">icalparser_parse</a>(parser, read_stream);</div> <div class="line"> </div> <div class="line"> <span class="comment">// once we parsed a component, print it</span></div> <div class="line"> printf(<span class="stringliteral">"%s"</span>, icalcomponent_as_ical_string(c));</div> <div class="line"> icalcomponent_free(c);</div> <div class="line"> </div> -<div class="line"> <a class="code hl_function" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> +<div class="line"> <a class="code" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> <div class="line">}</div> -<div class="ttc" id="aicalparser_8h_html_a00330df647417bb017a7daaaffafddec"><div class="ttname"><a href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec">icalparser_parse</a></div><div class="ttdeci">icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Message oriented parsing.</div><div class="ttdef"><b>Definition:</b> icalparser.c:622</div></div> +<div class="ttc" id="aicalparser_8h_html_aab80e10c3636d6476bc4920ae72d4b70"><div class="ttname"><a href="icalparser_8h.html#aab80e10c3636d6476bc4920ae72d4b70">icalparser_parse</a></div><div class="ttdeci">icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Message oriented parsing.</div><div class="ttdef"><b>Definition:</b> icalparser.c:629</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a5e1268344c61e44a0ec18085688f07fd" name="a5e1268344c61e44a0ec18085688f07fd"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a5e1268344c61e44a0ec18085688f07fd">◆ </a></span>icalparser_parse_string()</h2> +<a id="a966f6fd4bc931c06b2c596daeadb692f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a966f6fd4bc931c06b2c596daeadb692f">◆ </a></span>icalparser_parse_string()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * icalparser_parse_string </td> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalparser_parse_string </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em></td><td>)</td> @@ -550,21 +551,21 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">char</span> *ical_string;</div> <div class="line"> </div> <div class="line"><span class="comment">// parse ical_string</span></div> -<div class="line"><a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *component = <a class="code hl_function" href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd">icalparser_parse_string</a>(ical_string);</div> +<div class="line"><a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *component = <a class="code" href="icalparser_8h.html#a966f6fd4bc931c06b2c596daeadb692f">icalparser_parse_string</a>(ical_string);</div> <div class="line"> </div> -<div class="line"><span class="keywordflow">if</span>(!<a class="code hl_define" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> || component == NULL) {</div> +<div class="line"><span class="keywordflow">if</span>(!<a class="code" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a> || component == NULL) {</div> <div class="line"> <span class="comment">// use component ...</span></div> <div class="line">}</div> <div class="line"> </div> <div class="line"><span class="comment">// release component</span></div> <div class="line">icalcomponent_free(component);</div> -<div class="ttc" id="aicalerror_8h_html_ad2562706150f5c5a4d9b0ca149d78e37"><div class="ttname"><a href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a></div><div class="ttdeci">#define icalerrno</div><div class="ttdoc">Access the current icalerrno value.</div><div class="ttdef"><b>Definition:</b> icalerror.h:135</div></div> -<div class="ttc" id="aicalparser_8h_html_a5e1268344c61e44a0ec18085688f07fd"><div class="ttname"><a href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd">icalparser_parse_string</a></div><div class="ttdeci">icalcomponent * icalparser_parse_string(const char *str)</div><div class="ttdoc">Parses a string and returns the parsed icalcomponent.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1336</div></div> +<div class="ttc" id="aicalerror_8h_html_ad2562706150f5c5a4d9b0ca149d78e37"><div class="ttname"><a href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a></div><div class="ttdeci">#define icalerrno</div><div class="ttdoc">Access the current icalerrno value.</div><div class="ttdef"><b>Definition:</b> icalerror.h:144</div></div> +<div class="ttc" id="aicalparser_8h_html_a966f6fd4bc931c06b2c596daeadb692f"><div class="ttname"><a href="icalparser_8h.html#a966f6fd4bc931c06b2c596daeadb692f">icalparser_parse_string</a></div><div class="ttdeci">icalcomponent * icalparser_parse_string(const char *str)</div><div class="ttdoc">Parses a string and returns the parsed icalcomponent.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1341</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="aae6d08b4084610e225621a25dddd7689" name="aae6d08b4084610e225621a25dddd7689"></a> +<a id="aae6d08b4084610e225621a25dddd7689"></a> <h2 class="memtitle"><span class="permalink"><a href="#aae6d08b4084610e225621a25dddd7689">◆ </a></span>icalparser_set_gen_data()</h2> <div class="memitem"> @@ -598,14 +599,14 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </table> </dd> </dl> -<p>If you use any of the icalparser_parser() or <a class="el" href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3" title="Given a line generator function, returns a single iCal content line.">icalparser_get_line()</a> functions, the <em>line_gen_func</em> that they expect has a third <code>void* d</code> argument. This function sets what will be passed to your <em>line_gen_function</em> as such argument. </p> +<p>If you use any of the icalparser_parser() or <a class="el" href="icalparser_8h.html#a1e9b165c1aa2ba82605bcccadf85f74c" title="Given a line generator function, returns a single iCal content line.">icalparser_get_line()</a> functions, the <em>line_gen_func</em> that they expect has a third <code>void *d</code> argument. This function sets what will be passed to your <em>line_gen_function</em> as such argument. </p> </div> </div> </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> |