diff options
Diffstat (limited to 'apidocs/icalrecur_8h.html')
| -rw-r--r-- | apidocs/icalrecur_8h.html | 407 |
1 files changed, 110 insertions, 297 deletions
diff --git a/apidocs/icalrecur_8h.html b/apidocs/icalrecur_8h.html index 639de8d3..c09f6a08 100644 --- a/apidocs/icalrecur_8h.html +++ b/apidocs/icalrecur_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: icalrecur.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" @@ -72,7 +72,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">icalrecur.h File Reference</div></div> + <div class="headertitle"> +<div class="title">icalrecur.h File Reference</div> </div> </div><!--header--> <div class="contents"> @@ -81,71 +82,64 @@ $(function() { <p><a href="icalrecur_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="structicalrecurrencetype.html">icalrecurrencetype</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="define-members" name="define-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> -<tr class="memitem:a88c777bba1c5287ec7a262a8cf140209"><td class="memItemLeft" align="right" valign="top"><a id="a88c777bba1c5287ec7a262a8cf140209" name="a88c777bba1c5287ec7a262a8cf140209"></a> +<tr class="memitem:a88c777bba1c5287ec7a262a8cf140209"><td class="memItemLeft" align="right" valign="top"><a id="a88c777bba1c5287ec7a262a8cf140209"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_DAY_SIZE</b>   7*(ICAL_BY_WEEKNO_SIZE-1)+1 /* 1 to N */</td></tr> <tr class="separator:a88c777bba1c5287ec7a262a8cf140209"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af7660eef516049982e6ea1aa56d7a14f"><td class="memItemLeft" align="right" valign="top"><a id="af7660eef516049982e6ea1aa56d7a14f" name="af7660eef516049982e6ea1aa56d7a14f"></a> +<tr class="memitem:af7660eef516049982e6ea1aa56d7a14f"><td class="memItemLeft" align="right" valign="top"><a id="af7660eef516049982e6ea1aa56d7a14f"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_HOUR_SIZE</b>   25 /* 0 to 23 */</td></tr> <tr class="separator:af7660eef516049982e6ea1aa56d7a14f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1328acf3383993b85d9819702a94dd8a"><td class="memItemLeft" align="right" valign="top"><a id="a1328acf3383993b85d9819702a94dd8a" name="a1328acf3383993b85d9819702a94dd8a"></a> +<tr class="memitem:a1328acf3383993b85d9819702a94dd8a"><td class="memItemLeft" align="right" valign="top"><a id="a1328acf3383993b85d9819702a94dd8a"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MINUTE_SIZE</b>   61 /* 0 to 59 */</td></tr> <tr class="separator:a1328acf3383993b85d9819702a94dd8a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3ba206a293eca6a045c9e24b75516528"><td class="memItemLeft" align="right" valign="top"><a id="a3ba206a293eca6a045c9e24b75516528" name="a3ba206a293eca6a045c9e24b75516528"></a> +<tr class="memitem:a3ba206a293eca6a045c9e24b75516528"><td class="memItemLeft" align="right" valign="top"><a id="a3ba206a293eca6a045c9e24b75516528"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MONTH_SIZE</b>   14 /* 1 to 13 */</td></tr> <tr class="separator:a3ba206a293eca6a045c9e24b75516528"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7d6e5cf6656a21e1fede23a4af633f31"><td class="memItemLeft" align="right" valign="top"><a id="a7d6e5cf6656a21e1fede23a4af633f31" name="a7d6e5cf6656a21e1fede23a4af633f31"></a> +<tr class="memitem:a7d6e5cf6656a21e1fede23a4af633f31"><td class="memItemLeft" align="right" valign="top"><a id="a7d6e5cf6656a21e1fede23a4af633f31"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_MONTHDAY_SIZE</b>   32 /* 1 to 31 */</td></tr> <tr class="separator:a7d6e5cf6656a21e1fede23a4af633f31"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acec51b2d651f24e31b00627b60b12728"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#acec51b2d651f24e31b00627b60b12728">ICAL_BY_SECOND_SIZE</a>   62 /* 0 to 60 */</td></tr> <tr class="separator:acec51b2d651f24e31b00627b60b12728"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8a02214312ee862af943de714ad30c1f"><td class="memItemLeft" align="right" valign="top"><a id="a8a02214312ee862af943de714ad30c1f" name="a8a02214312ee862af943de714ad30c1f"></a> +<tr class="memitem:a8a02214312ee862af943de714ad30c1f"><td class="memItemLeft" align="right" valign="top"><a id="a8a02214312ee862af943de714ad30c1f"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_SETPOS_SIZE</b>   ICAL_BY_YEARDAY_SIZE /* 1 to N */</td></tr> <tr class="separator:a8a02214312ee862af943de714ad30c1f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a213222b2455537fceb2814e9e084e95a"><td class="memItemLeft" align="right" valign="top"><a id="a213222b2455537fceb2814e9e084e95a" name="a213222b2455537fceb2814e9e084e95a"></a> +<tr class="memitem:a213222b2455537fceb2814e9e084e95a"><td class="memItemLeft" align="right" valign="top"><a id="a213222b2455537fceb2814e9e084e95a"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_WEEKNO_SIZE</b>   56 /* 1 to 55 */</td></tr> <tr class="separator:a213222b2455537fceb2814e9e084e95a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aad632e88ecae484b09c8ca4be1bfd58b"><td class="memItemLeft" align="right" valign="top"><a id="aad632e88ecae484b09c8ca4be1bfd58b" name="aad632e88ecae484b09c8ca4be1bfd58b"></a> +<tr class="memitem:aad632e88ecae484b09c8ca4be1bfd58b"><td class="memItemLeft" align="right" valign="top"><a id="aad632e88ecae484b09c8ca4be1bfd58b"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICAL_BY_YEARDAY_SIZE</b>   386 /* 1 to 385 */</td></tr> <tr class="separator:aad632e88ecae484b09c8ca4be1bfd58b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af8f79ef6c5bb7d36d0862fea359c17fd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#af8f79ef6c5bb7d36d0862fea359c17fd">ICALRECURRENCETYPE_INITIALIZER</a></td></tr> +<tr class="memitem:af8f79ef6c5bb7d36d0862fea359c17fd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>ICALRECURRENCETYPE_INITIALIZER</b></td></tr> <tr class="separator:af8f79ef6c5bb7d36d0862fea359c17fd"><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:a6ee883e25caacc3f6e5ce05d4d45a645"><td class="memItemLeft" align="right" valign="top"><a id="a6ee883e25caacc3f6e5ce05d4d45a645" name="a6ee883e25caacc3f6e5ce05d4d45a645"></a> -typedef enum ical_invalid_rrule_handling </td><td class="memItemRight" valign="bottom"><b>ical_invalid_rrule_handling</b></td></tr> -<tr class="separator:a6ee883e25caacc3f6e5ce05d4d45a645"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a15b0ec0400bb64fcfd625d5a5511db7f"><td class="memItemLeft" align="right" valign="top"><a id="a15b0ec0400bb64fcfd625d5a5511db7f" name="a15b0ec0400bb64fcfd625d5a5511db7f"></a> +<tr class="memitem:a15b0ec0400bb64fcfd625d5a5511db7f"><td class="memItemLeft" align="right" valign="top"><a id="a15b0ec0400bb64fcfd625d5a5511db7f"></a> typedef struct <a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator_impl</a> </td><td class="memItemRight" valign="bottom"><b>icalrecur_iterator</b></td></tr> <tr class="separator:a15b0ec0400bb64fcfd625d5a5511db7f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:afd62e4356b0f28df5892167477be989d"><td class="memItemLeft" align="right" valign="top"><a id="afd62e4356b0f28df5892167477be989d" name="afd62e4356b0f28df5892167477be989d"></a> +<tr class="memitem:afd62e4356b0f28df5892167477be989d"><td class="memItemLeft" align="right" valign="top"><a id="afd62e4356b0f28df5892167477be989d"></a> typedef enum icalrecurrencetype_frequency </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_frequency</b></td></tr> <tr class="separator:afd62e4356b0f28df5892167477be989d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a25bc5be48c7458f25765a8f59ef1eb8c"><td class="memItemLeft" align="right" valign="top"><a id="a25bc5be48c7458f25765a8f59ef1eb8c" name="a25bc5be48c7458f25765a8f59ef1eb8c"></a> +<tr class="memitem:a25bc5be48c7458f25765a8f59ef1eb8c"><td class="memItemLeft" align="right" valign="top"><a id="a25bc5be48c7458f25765a8f59ef1eb8c"></a> typedef enum icalrecurrencetype_skip </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_skip</b></td></tr> <tr class="separator:a25bc5be48c7458f25765a8f59ef1eb8c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a75f2d7439c6001523b78dcef9b26ddad"><td class="memItemLeft" align="right" valign="top"><a id="a75f2d7439c6001523b78dcef9b26ddad" name="a75f2d7439c6001523b78dcef9b26ddad"></a> +<tr class="memitem:a75f2d7439c6001523b78dcef9b26ddad"><td class="memItemLeft" align="right" valign="top"><a id="a75f2d7439c6001523b78dcef9b26ddad"></a> typedef enum icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_weekday</b></td></tr> <tr class="separator:a75f2d7439c6001523b78dcef9b26ddad"><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:a85aad1aeea58a53b5a0399a2fca38890"><td class="memItemLeft" align="right" valign="top"><a id="a85aad1aeea58a53b5a0399a2fca38890" name="a85aad1aeea58a53b5a0399a2fca38890"></a>enum  </td><td class="memItemRight" valign="bottom"><b>ical_invalid_rrule_handling</b> { <b>ICAL_RRULE_TREAT_AS_ERROR</b> = 0 -, <b>ICAL_RRULE_IGNORE_INVALID</b> = 1 - }</td></tr> -<tr class="separator:a85aad1aeea58a53b5a0399a2fca38890"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a593dc289d9bb0313584701e0675cf303"><td class="memItemLeft" align="right" valign="top"><a id="a593dc289d9bb0313584701e0675cf303" name="a593dc289d9bb0313584701e0675cf303"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrence_array_max_values</b> { <b>ICAL_RECURRENCE_ARRAY_MAX</b> = 0x7f7f +<tr class="memitem:a593dc289d9bb0313584701e0675cf303"><td class="memItemLeft" align="right" valign="top"><a id="a593dc289d9bb0313584701e0675cf303"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrence_array_max_values</b> { <b>ICAL_RECURRENCE_ARRAY_MAX</b> = 0x7f7f , <b>ICAL_RECURRENCE_ARRAY_MAX_BYTE</b> = 0x7f }</td></tr> <tr class="separator:a593dc289d9bb0313584701e0675cf303"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a203e6ca308804a67ff343837e7c11a61"><td class="memItemLeft" align="right" valign="top"><a id="a203e6ca308804a67ff343837e7c11a61" name="a203e6ca308804a67ff343837e7c11a61"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_frequency</b> { <br /> +<tr class="memitem:a203e6ca308804a67ff343837e7c11a61"><td class="memItemLeft" align="right" valign="top"><a id="a203e6ca308804a67ff343837e7c11a61"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_frequency</b> { <br />   <b>ICAL_SECONDLY_RECURRENCE</b> = 0 , <b>ICAL_MINUTELY_RECURRENCE</b> = 1 , <b>ICAL_HOURLY_RECURRENCE</b> = 2 @@ -158,13 +152,13 @@ Enumerations</h2></td></tr> <br /> }</td></tr> <tr class="separator:a203e6ca308804a67ff343837e7c11a61"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a46e0128948e7c4c5c1e120061211ddea"><td class="memItemLeft" align="right" valign="top"><a id="a46e0128948e7c4c5c1e120061211ddea" name="a46e0128948e7c4c5c1e120061211ddea"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_skip</b> { <b>ICAL_SKIP_BACKWARD</b> = 0 +<tr class="memitem:a46e0128948e7c4c5c1e120061211ddea"><td class="memItemLeft" align="right" valign="top"><a id="a46e0128948e7c4c5c1e120061211ddea"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_skip</b> { <b>ICAL_SKIP_BACKWARD</b> = 0 , <b>ICAL_SKIP_FORWARD</b> , <b>ICAL_SKIP_OMIT</b> , <b>ICAL_SKIP_UNDEFINED</b> }</td></tr> <tr class="separator:a46e0128948e7c4c5c1e120061211ddea"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0d3df238238f2689b2cc48b162a9507b"><td class="memItemLeft" align="right" valign="top"><a id="a0d3df238238f2689b2cc48b162a9507b" name="a0d3df238238f2689b2cc48b162a9507b"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_weekday</b> { <br /> +<tr class="memitem:a0d3df238238f2689b2cc48b162a9507b"><td class="memItemLeft" align="right" valign="top"><a id="a0d3df238238f2689b2cc48b162a9507b"></a>enum  </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_weekday</b> { <br />   <b>ICAL_NO_WEEKDAY</b> , <b>ICAL_SUNDAY_WEEKDAY</b> , <b>ICAL_MONDAY_WEEKDAY</b> @@ -178,56 +172,44 @@ Enumerations</h2></td></tr> }</td></tr> <tr class="separator:a0d3df238238f2689b2cc48b162a9507b"><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:a9eb6bec2840d2b84efb14d50731b6aaa"><td class="memItemLeft" align="right" valign="top"><a id="a9eb6bec2840d2b84efb14d50731b6aaa" name="a9eb6bec2840d2b84efb14d50731b6aaa"></a> -ical_invalid_rrule_handling </td><td class="memItemRight" valign="bottom"><b>ical_get_invalid_rrule_handling_setting</b> (void)</td></tr> -<tr class="separator:a9eb6bec2840d2b84efb14d50731b6aaa"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3cc3b729a411ed8f1e046f1bbf84bf65"><td class="memItemLeft" align="right" valign="top"><a id="a3cc3b729a411ed8f1e046f1bbf84bf65" name="a3cc3b729a411ed8f1e046f1bbf84bf65"></a> -void </td><td class="memItemRight" valign="bottom"><b>ical_set_invalid_rrule_handling_setting</b> (ical_invalid_rrule_handling newSetting)</td></tr> -<tr class="separator:a3cc3b729a411ed8f1e046f1bbf84bf65"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a805af3920689b3b77d6db54317784409"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a805af3920689b3b77d6db54317784409">icalrecur_expand_recurrence</a> (const char *rule, icaltime_t start, int count, icaltime_t *array)</td></tr> -<tr class="memdesc:a805af3920689b3b77d6db54317784409"><td class="mdescLeft"> </td><td class="mdescRight">Fills an array with the 'count' number of occurrences generated by the rrule. <a href="icalrecur_8h.html#a805af3920689b3b77d6db54317784409">More...</a><br /></td></tr> -<tr class="separator:a805af3920689b3b77d6db54317784409"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3b9e06ff25b276716636610c58e0abf2"><td class="memItemLeft" align="right" valign="top"><a id="a3b9e06ff25b276716636610c58e0abf2" name="a3b9e06ff25b276716636610c58e0abf2"></a> +<tr class="memitem:a08bc5e484eb46ba9e02fb037e2e01c29"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a08bc5e484eb46ba9e02fb037e2e01c29">icalrecur_expand_recurrence</a> (const char *rule, time_t start, int count, time_t *array)</td></tr> +<tr class="memdesc:a08bc5e484eb46ba9e02fb037e2e01c29"><td class="mdescLeft"> </td><td class="mdescRight">Fills an array with the 'count' number of occurrences generated by the rrule. <a href="icalrecur_8h.html#a08bc5e484eb46ba9e02fb037e2e01c29">More...</a><br /></td></tr> +<tr class="separator:a08bc5e484eb46ba9e02fb037e2e01c29"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0e33697a7125538f79ec4c17177f35cb"><td class="memItemLeft" align="right" valign="top"><a id="a0e33697a7125538f79ec4c17177f35cb"></a> const char * </td><td class="memItemRight" valign="bottom"><b>icalrecur_freq_to_string</b> (icalrecurrencetype_frequency kind)</td></tr> -<tr class="separator:a3b9e06ff25b276716636610c58e0abf2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="separator:a0e33697a7125538f79ec4c17177f35cb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a14daf9df313fdad9f536a7d9242b4cdc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a14daf9df313fdad9f536a7d9242b4cdc">icalrecur_iterator_free</a> (<a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *)</td></tr> <tr class="separator:a14daf9df313fdad9f536a7d9242b4cdc"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a34c26e8377e120586398b06d37a1f63e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a34c26e8377e120586398b06d37a1f63e">icalrecur_iterator_new</a> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> rule, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> dtstart)</td></tr> -<tr class="separator:a34c26e8377e120586398b06d37a1f63e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3259c2b9b03763d8ee02868816d6261a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a3259c2b9b03763d8ee02868816d6261a">icalrecur_iterator_new</a> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> rule, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> dtstart)</td></tr> +<tr class="separator:a3259c2b9b03763d8ee02868816d6261a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2e10af320612cd7ab8c6fb6177ade3e3"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a2e10af320612cd7ab8c6fb6177ade3e3">icalrecur_iterator_next</a> (<a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *)</td></tr> <tr class="separator:a2e10af320612cd7ab8c6fb6177ade3e3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa15f2414c34796d414acce20ab7a2bf0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#aa15f2414c34796d414acce20ab7a2bf0">icalrecur_iterator_prev</a> (<a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *)</td></tr> -<tr class="separator:aa15f2414c34796d414acce20ab7a2bf0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:abf97ae59c917f9a2856257418dcb1016"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#abf97ae59c917f9a2856257418dcb1016">icalrecur_iterator_set_end</a> (<a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *impl, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> end)</td></tr> -<tr class="separator:abf97ae59c917f9a2856257418dcb1016"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af830056b191d4e037813ff27c60932cf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#af830056b191d4e037813ff27c60932cf">icalrecur_iterator_set_range</a> (<a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *impl, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> from, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> to)</td></tr> -<tr class="separator:af830056b191d4e037813ff27c60932cf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab632c95c37375ef11d62d8742e8406d5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#ab632c95c37375ef11d62d8742e8406d5">icalrecur_iterator_set_start</a> (<a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *impl, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> start)</td></tr> <tr class="separator:ab632c95c37375ef11d62d8742e8406d5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2319613578f2a47d4be33618ea1fde1d"><td class="memItemLeft" align="right" valign="top"><a id="a2319613578f2a47d4be33618ea1fde1d" name="a2319613578f2a47d4be33618ea1fde1d"></a> +<tr class="memitem:aed40c56e1a7955246feade6926c09ac3"><td class="memItemLeft" align="right" valign="top"><a id="aed40c56e1a7955246feade6926c09ac3"></a> const char * </td><td class="memItemRight" valign="bottom"><b>icalrecur_skip_to_string</b> (icalrecurrencetype_skip kind)</td></tr> -<tr class="separator:a2319613578f2a47d4be33618ea1fde1d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6011fe4f7973affecf45fd377de2b83a"><td class="memItemLeft" align="right" valign="top"><a id="a6011fe4f7973affecf45fd377de2b83a" name="a6011fe4f7973affecf45fd377de2b83a"></a> +<tr class="separator:aed40c56e1a7955246feade6926c09ac3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6011fe4f7973affecf45fd377de2b83a"><td class="memItemLeft" align="right" valign="top"><a id="a6011fe4f7973affecf45fd377de2b83a"></a> icalrecurrencetype_frequency </td><td class="memItemRight" valign="bottom"><b>icalrecur_string_to_freq</b> (const char *str)</td></tr> <tr class="separator:a6011fe4f7973affecf45fd377de2b83a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1285d50b79d9558543716fdce98d5c4f"><td class="memItemLeft" align="right" valign="top"><a id="a1285d50b79d9558543716fdce98d5c4f" name="a1285d50b79d9558543716fdce98d5c4f"></a> +<tr class="memitem:a1285d50b79d9558543716fdce98d5c4f"><td class="memItemLeft" align="right" valign="top"><a id="a1285d50b79d9558543716fdce98d5c4f"></a> icalrecurrencetype_skip </td><td class="memItemRight" valign="bottom"><b>icalrecur_string_to_skip</b> (const char *str)</td></tr> <tr class="separator:a1285d50b79d9558543716fdce98d5c4f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad60e4e0c33acf7f90dbbf891e2326a8e"><td class="memItemLeft" align="right" valign="top"><a id="ad60e4e0c33acf7f90dbbf891e2326a8e" name="ad60e4e0c33acf7f90dbbf891e2326a8e"></a> +<tr class="memitem:ad60e4e0c33acf7f90dbbf891e2326a8e"><td class="memItemLeft" align="right" valign="top"><a id="ad60e4e0c33acf7f90dbbf891e2326a8e"></a> icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><b>icalrecur_string_to_weekday</b> (const char *str)</td></tr> <tr class="separator:ad60e4e0c33acf7f90dbbf891e2326a8e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a20b3fd7dfbcf3a75186714f59ddcb07a"><td class="memItemLeft" align="right" valign="top"><a id="a20b3fd7dfbcf3a75186714f59ddcb07a" name="a20b3fd7dfbcf3a75186714f59ddcb07a"></a> +<tr class="memitem:ab67ef19d5a1614ae832a5419731de38a"><td class="memItemLeft" align="right" valign="top"><a id="ab67ef19d5a1614ae832a5419731de38a"></a> const char * </td><td class="memItemRight" valign="bottom"><b>icalrecur_weekday_to_string</b> (icalrecurrencetype_weekday kind)</td></tr> -<tr class="separator:a20b3fd7dfbcf3a75186714f59ddcb07a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa908a1c2cc241ca48cb1df357c1f623b"><td class="memItemLeft" align="right" valign="top"><a id="aa908a1c2cc241ca48cb1df357c1f623b" name="aa908a1c2cc241ca48cb1df357c1f623b"></a> +<tr class="separator:ab67ef19d5a1614ae832a5419731de38a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a45f67a448ee73729ad1203276434ee52"><td class="memItemLeft" align="right" valign="top"><a id="a45f67a448ee73729ad1203276434ee52"></a> char * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_as_string</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *recur)</td></tr> -<tr class="separator:aa908a1c2cc241ca48cb1df357c1f623b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af6013aeae190a26955eddd7cf1a00baf"><td class="memItemLeft" align="right" valign="top"><a id="af6013aeae190a26955eddd7cf1a00baf" name="af6013aeae190a26955eddd7cf1a00baf"></a> +<tr class="separator:a45f67a448ee73729ad1203276434ee52"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a27204e0666e4e4e3b7d2ef0f159ac5a3"><td class="memItemLeft" align="right" valign="top"><a id="a27204e0666e4e4e3b7d2ef0f159ac5a3"></a> char * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_as_string_r</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *recur)</td></tr> -<tr class="separator:af6013aeae190a26955eddd7cf1a00baf"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad1bf76a6221d8aa78387b20a537491ce"><td class="memItemLeft" align="right" valign="top"><a id="ad1bf76a6221d8aa78387b20a537491ce" name="ad1bf76a6221d8aa78387b20a537491ce"></a> +<tr class="separator:a27204e0666e4e4e3b7d2ef0f159ac5a3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad1bf76a6221d8aa78387b20a537491ce"><td class="memItemLeft" align="right" valign="top"><a id="ad1bf76a6221d8aa78387b20a537491ce"></a> void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_clear</b> (struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> *r)</td></tr> <tr class="separator:ad1bf76a6221d8aa78387b20a537491ce"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a96c160e7e6b16e0e369c540f2ee164c7"><td class="memItemLeft" align="right" valign="top">enum icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a96c160e7e6b16e0e369c540f2ee164c7">icalrecurrencetype_day_day_of_week</a> (short day)</td></tr> @@ -236,58 +218,55 @@ void </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_cl <tr class="memitem:aa730e9ac327064456902076b718400f4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#aa730e9ac327064456902076b718400f4">icalrecurrencetype_day_position</a> (short day)</td></tr> <tr class="memdesc:aa730e9ac327064456902076b718400f4"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a day to a position of the weekday. <a href="icalrecur_8h.html#aa730e9ac327064456902076b718400f4">More...</a><br /></td></tr> <tr class="separator:aa730e9ac327064456902076b718400f4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1de1894ce541ebf3d5a3cbaf6c5978e1"><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a1de1894ce541ebf3d5a3cbaf6c5978e1">icalrecurrencetype_encode_day</a> (enum icalrecurrencetype_weekday weekday, int position)</td></tr> -<tr class="separator:a1de1894ce541ebf3d5a3cbaf6c5978e1"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa9d7b1ae411cd1eeb7464ee481e1609b"><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#aa9d7b1ae411cd1eeb7464ee481e1609b">icalrecurrencetype_encode_month</a> (int month, int is_leap)</td></tr> -<tr class="separator:aa9d7b1ae411cd1eeb7464ee481e1609b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0e8ebcf355ba22299f553f8f5e657926"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a0e8ebcf355ba22299f553f8f5e657926">icalrecurrencetype_from_string</a> (const char *str)</td></tr> <tr class="separator:a0e8ebcf355ba22299f553f8f5e657926"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a37565d0a4c56c67bd08b556d58f59b5c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalrecur_8h.html#a37565d0a4c56c67bd08b556d58f59b5c">icalrecurrencetype_month_is_leap</a> (short month)</td></tr> +<tr class="memitem:a37565d0a4c56c67bd08b556d58f59b5c"><td class="memItemLeft" align="right" valign="top"><a id="a37565d0a4c56c67bd08b556d58f59b5c"></a> +int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_month_is_leap</b> (short month)</td></tr> <tr class="separator:a37565d0a4c56c67bd08b556d58f59b5c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:adcf246d5de93b17c7c72444163671297"><td class="memItemLeft" align="right" valign="top"><a id="adcf246d5de93b17c7c72444163671297" name="adcf246d5de93b17c7c72444163671297"></a> +<tr class="memitem:adcf246d5de93b17c7c72444163671297"><td class="memItemLeft" align="right" valign="top"><a id="adcf246d5de93b17c7c72444163671297"></a> int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_month_month</b> (short month)</td></tr> <tr class="separator:adcf246d5de93b17c7c72444163671297"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a69fc2030e8776dc3184cb88ca4e2dd70"><td class="memItemLeft" align="right" valign="top"><a id="a69fc2030e8776dc3184cb88ca4e2dd70" name="a69fc2030e8776dc3184cb88ca4e2dd70"></a> +<tr class="memitem:a69fc2030e8776dc3184cb88ca4e2dd70"><td class="memItemLeft" align="right" valign="top"><a id="a69fc2030e8776dc3184cb88ca4e2dd70"></a> int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rscale_is_supported</b> (void)</td></tr> <tr class="separator:a69fc2030e8776dc3184cb88ca4e2dd70"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8941770a8f65ece2561aa8786f8575c0"><td class="memItemLeft" align="right" valign="top"><a id="a8941770a8f65ece2561aa8786f8575c0" name="a8941770a8f65ece2561aa8786f8575c0"></a> +<tr class="memitem:a537c373703f23e8c86f3da3324123f44"><td class="memItemLeft" align="right" valign="top"><a id="a537c373703f23e8c86f3da3324123f44"></a> <a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rscale_supported_calendars</b> (void)</td></tr> -<tr class="separator:a8941770a8f65ece2561aa8786f8575c0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="separator:a537c373703f23e8c86f3da3324123f44"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p >Routines for dealing with recurring time. </p> -<p >How to use:</p> -<p >1) Get a rule and a start time from a component</p> +<div class="textblock"><p>Routines for dealing with recurring time. </p> +<p>How to use:</p> +<p>1) Get a rule and a start time from a component</p> <div class="fragment"><div class="line">icalproperty rrule;</div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicalrecurrencetype.html">icalrecurrencetype</a> recur;</div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> dtstart;</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicalrecurrencetype.html">icalrecurrencetype</a> recur;</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> dtstart;</div> <div class="line"> </div> <div class="line">rrule = icalcomponent_get_first_property(comp,ICAL_RRULE_PROPERTY);</div> <div class="line">recur = icalproperty_get_rrule(rrule);</div> <div class="line">start = icalproperty_get_dtstart(dtstart);</div> -<div class="ttc" id="astructicalrecurrencetype_html"><div class="ttname"><a href="structicalrecurrencetype.html">icalrecurrencetype</a></div><div class="ttdef"><b>Definition:</b> icalrecur.h:144</div></div> -<div class="ttc" id="astructicaltimetype_html"><div class="ttname"><a href="structicaltimetype.html">icaltimetype</a></div><div class="ttdef"><b>Definition:</b> icaltime.h:97</div></div> -</div><!-- fragment --><p >Or, just make them up:</p> -<div class="fragment"><div class="line">recur = <a class="code hl_function" href="icalrecur_8h.html#a0e8ebcf355ba22299f553f8f5e657926">icalrecurrencetype_from_string</a>(<span class="stringliteral">"FREQ=YEARLY;BYDAY=SU,WE"</span>);</div> -<div class="line">dtstart = <a class="code hl_function" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5">icaltime_from_string</a>(<span class="stringliteral">"19970101T123000"</span>)</div> -<div class="ttc" id="aicalrecur_8h_html_a0e8ebcf355ba22299f553f8f5e657926"><div class="ttname"><a href="icalrecur_8h.html#a0e8ebcf355ba22299f553f8f5e657926">icalrecurrencetype_from_string</a></div><div class="ttdeci">struct icalrecurrencetype icalrecurrencetype_from_string(const char *str)</div><div class="ttdef"><b>Definition:</b> icalrecur.c:634</div></div> -<div class="ttc" id="aicaltime_8h_html_a1b66b9f52a9823b95e4cd33f9dd9b8e5"><div class="ttname"><a href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5">icaltime_from_string</a></div><div class="ttdeci">struct icaltimetype icaltime_from_string(const char *str)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> icaltime.c:330</div></div> -</div><!-- fragment --><p >2) Create an iterator</p> -<div class="fragment"><div class="line"><a class="code hl_struct" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *ritr;</div> -<div class="line">ritr = <a class="code hl_function" href="icalrecur_8h.html#a34c26e8377e120586398b06d37a1f63e">icalrecur_iterator_new</a>(recur,start);</div> -<div class="ttc" id="aicalrecur_8h_html_a34c26e8377e120586398b06d37a1f63e"><div class="ttname"><a href="icalrecur_8h.html#a34c26e8377e120586398b06d37a1f63e">icalrecur_iterator_new</a></div><div class="ttdeci">icalrecur_iterator * icalrecur_iterator_new(struct icalrecurrencetype rule, struct icaltimetype dtstart)</div><div class="ttdef"><b>Definition:</b> icalrecur.c:1931</div></div> -<div class="ttc" id="astructicalrecur__iterator__impl_html"><div class="ttname"><a href="structicalrecur__iterator__impl.html">icalrecur_iterator_impl</a></div><div class="ttdef"><b>Definition:</b> icalrecur.c:933</div></div> -</div><!-- fragment --><p >3) Iterator over the occurrences</p> -<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> next;</div> -<div class="line"><span class="keywordflow">while</span> (next = <a class="code hl_function" href="icalrecur_8h.html#a2e10af320612cd7ab8c6fb6177ade3e3">icalrecur_iterator_next</a>(ritr)</div> -<div class="line"> && !<a class="code hl_function" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(next){</div> +<div class="ttc" id="astructicalrecurrencetype_html"><div class="ttname"><a href="structicalrecurrencetype.html">icalrecurrencetype</a></div><div class="ttdef"><b>Definition:</b> icalrecur.h:152</div></div> +<div class="ttc" id="astructicaltimetype_html"><div class="ttname"><a href="structicaltimetype.html">icaltimetype</a></div><div class="ttdef"><b>Definition:</b> icaltime.h:105</div></div> +</div><!-- fragment --><p>Or, just make them up:</p> +<div class="fragment"><div class="line">recur = <a class="code" href="icalrecur_8h.html#a0e8ebcf355ba22299f553f8f5e657926">icalrecurrencetype_from_string</a>(<span class="stringliteral">"FREQ=YEARLY;BYDAY=SU,WE"</span>);</div> +<div class="line">dtstart = <a class="code" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5">icaltime_from_string</a>(<span class="stringliteral">"19970101T123000"</span>)</div> +<div class="ttc" id="aicalrecur_8h_html_a0e8ebcf355ba22299f553f8f5e657926"><div class="ttname"><a href="icalrecur_8h.html#a0e8ebcf355ba22299f553f8f5e657926">icalrecurrencetype_from_string</a></div><div class="ttdeci">struct icalrecurrencetype icalrecurrencetype_from_string(const char *str)</div><div class="ttdef"><b>Definition:</b> icalrecur.c:555</div></div> +<div class="ttc" id="aicaltime_8h_html_a1b66b9f52a9823b95e4cd33f9dd9b8e5"><div class="ttname"><a href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5">icaltime_from_string</a></div><div class="ttdeci">struct icaltimetype icaltime_from_string(const char *str)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> icaltime.c:345</div></div> +</div><!-- fragment --><p>2) Create an iterator</p> +<div class="fragment"><div class="line"><a class="code" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> *ritr;</div> +<div class="line">ritr = <a class="code" href="icalrecur_8h.html#a3259c2b9b03763d8ee02868816d6261a">icalrecur_iterator_new</a>(recur,start);</div> +<div class="ttc" id="aicalrecur_8h_html_a3259c2b9b03763d8ee02868816d6261a"><div class="ttname"><a href="icalrecur_8h.html#a3259c2b9b03763d8ee02868816d6261a">icalrecur_iterator_new</a></div><div class="ttdeci">icalrecur_iterator * icalrecur_iterator_new(struct icalrecurrencetype rule, struct icaltimetype dtstart)</div><div class="ttdef"><b>Definition:</b> icalrecur.c:1952</div></div> +<div class="ttc" id="astructicalrecur__iterator__impl_html"><div class="ttname"><a href="structicalrecur__iterator__impl.html">icalrecur_iterator_impl</a></div><div class="ttdef"><b>Definition:</b> icalrecur.c:925</div></div> +</div><!-- fragment --><p>3) Iterator over the occurrences</p> +<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> next;</div> +<div class="line"><span class="keywordflow">while</span> (next = <a class="code" href="icalrecur_8h.html#a2e10af320612cd7ab8c6fb6177ade3e3">icalrecur_iterator_next</a>(ritr)</div> +<div class="line"> && !<a class="code" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(next){</div> <div class="line"> Do something with next</div> <div class="line">}</div> -<div class="ttc" id="aicalrecur_8h_html_a2e10af320612cd7ab8c6fb6177ade3e3"><div class="ttname"><a href="icalrecur_8h.html#a2e10af320612cd7ab8c6fb6177ade3e3">icalrecur_iterator_next</a></div><div class="ttdeci">struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *)</div><div class="ttdef"><b>Definition:</b> icalrecur.c:3150</div></div> -<div class="ttc" id="aicaltime_8h_html_a97483d9daf2fc8f8b1bbdc0c75ced095"><div class="ttname"><a href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a></div><div class="ttdeci">int icaltime_is_null_time(const struct icaltimetype t)</div><div class="ttdoc">Returns true if the time is null.</div><div class="ttdef"><b>Definition:</b> icaltime.c:593</div></div> -</div><!-- fragment --><p >Note that the time returned by icalrecur_iterator_next is in whatever timezone that dtstart is in. </p> +<div class="ttc" id="aicalrecur_8h_html_a2e10af320612cd7ab8c6fb6177ade3e3"><div class="ttname"><a href="icalrecur_8h.html#a2e10af320612cd7ab8c6fb6177ade3e3">icalrecur_iterator_next</a></div><div class="ttdeci">struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *)</div><div class="ttdef"><b>Definition:</b> icalrecur.c:2933</div></div> +<div class="ttc" id="aicaltime_8h_html_a97483d9daf2fc8f8b1bbdc0c75ced095"><div class="ttname"><a href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a></div><div class="ttdeci">int icaltime_is_null_time(const struct icaltimetype t)</div><div class="ttdoc">Returns true if the time is null.</div><div class="ttdef"><b>Definition:</b> icaltime.c:617</div></div> +</div><!-- fragment --><p>Note that the time returned by icalrecur_iterator_next is in whatever timezone that dtstart is in. </p> </div><h2 class="groupheader">Macro Definition Documentation</h2> -<a id="acec51b2d651f24e31b00627b60b12728" name="acec51b2d651f24e31b00627b60b12728"></a> +<a id="acec51b2d651f24e31b00627b60b12728"></a> <h2 class="memtitle"><span class="permalink"><a href="#acec51b2d651f24e31b00627b60b12728">◆ </a></span>ICAL_BY_SECOND_SIZE</h2> <div class="memitem"> @@ -298,11 +277,11 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </tr> </table> </div><div class="memdoc"> -<p >Recurrence type routines </p> +<p>Recurrence type routines </p> </div> </div> -<a id="af8f79ef6c5bb7d36d0862fea359c17fd" name="af8f79ef6c5bb7d36d0862fea359c17fd"></a> +<a id="af8f79ef6c5bb7d36d0862fea359c17fd"></a> <h2 class="memtitle"><span class="permalink"><a href="#af8f79ef6c5bb7d36d0862fea359c17fd">◆ </a></span>ICALRECURRENCETYPE_INITIALIZER</h2> <div class="memitem"> @@ -335,8 +314,8 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </div> </div> <h2 class="groupheader">Function Documentation</h2> -<a id="a805af3920689b3b77d6db54317784409" name="a805af3920689b3b77d6db54317784409"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a805af3920689b3b77d6db54317784409">◆ </a></span>icalrecur_expand_recurrence()</h2> +<a id="a08bc5e484eb46ba9e02fb037e2e01c29"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a08bc5e484eb46ba9e02fb037e2e01c29">◆ </a></span>icalrecur_expand_recurrence()</h2> <div class="memitem"> <div class="memproto"> @@ -350,7 +329,7 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">icaltime_t </td> + <td class="paramtype">time_t </td> <td class="paramname"><em>start</em>, </td> </tr> <tr> @@ -362,7 +341,7 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">icaltime_t * </td> + <td class="paramtype">time_t * </td> <td class="paramname"><em>array</em> </td> </tr> <tr> @@ -374,12 +353,12 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </div><div class="memdoc"> <p>Fills an array with the 'count' number of occurrences generated by the rrule. </p> -<p >Specifically, this fills <code>array</code> up with at most 'count' icaltime_t values, each representing an occurrence time in seconds past the POSIX epoch.</p> -<p >Note that the times are returned in UTC, but the times are calculated in local time. You will have to convert the results back into local time before using them. </p> +<p>Specifically, this fills <code>array</code> up with at most 'count' time_t values, each representing an occurrence time in seconds past the POSIX epoch.</p> +<p>Note that the times are returned in UTC, but the times are calculated in local time. You will have to convert the results back into local time before using them. </p> </div> </div> -<a id="a14daf9df313fdad9f536a7d9242b4cdc" name="a14daf9df313fdad9f536a7d9242b4cdc"></a> +<a id="a14daf9df313fdad9f536a7d9242b4cdc"></a> <h2 class="memtitle"><span class="permalink"><a href="#a14daf9df313fdad9f536a7d9242b4cdc">◆ </a></span>icalrecur_iterator_free()</h2> <div class="memitem"> @@ -394,18 +373,18 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </tr> </table> </div><div class="memdoc"> -<p >Frees the iterator. </p> +<p>Frees the iterator. </p> </div> </div> -<a id="a34c26e8377e120586398b06d37a1f63e" name="a34c26e8377e120586398b06d37a1f63e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a34c26e8377e120586398b06d37a1f63e">◆ </a></span>icalrecur_iterator_new()</h2> +<a id="a3259c2b9b03763d8ee02868816d6261a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3259c2b9b03763d8ee02868816d6261a">◆ </a></span>icalrecur_iterator_new()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> * icalrecur_iterator_new </td> + <td class="memname"><a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a>* icalrecur_iterator_new </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structicalrecurrencetype.html">icalrecurrencetype</a> </td> <td class="paramname"><em>rule</em>, </td> @@ -423,11 +402,11 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </tr> </table> </div><div class="memdoc"> -<p >Creates a new recurrence rule iterator, starting at DTSTART. </p> +<p>Creates a new recurrence rule iterator, starting at DTSTART. </p> </div> </div> -<a id="a2e10af320612cd7ab8c6fb6177ade3e3" name="a2e10af320612cd7ab8c6fb6177ade3e3"></a> +<a id="a2e10af320612cd7ab8c6fb6177ade3e3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2e10af320612cd7ab8c6fb6177ade3e3">◆ </a></span>icalrecur_iterator_next()</h2> <div class="memitem"> @@ -442,98 +421,11 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </tr> </table> </div><div class="memdoc"> -<p >Gets the next occurrence from an iterator. </p> - -</div> -</div> -<a id="aa15f2414c34796d414acce20ab7a2bf0" name="aa15f2414c34796d414acce20ab7a2bf0"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aa15f2414c34796d414acce20ab7a2bf0">◆ </a></span>icalrecur_iterator_prev()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> icalrecur_iterator_prev </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> * </td> - <td class="paramname"><em>impl</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p >Gets the previous occurrence from an iterator. </p><dl class="section since"><dt>Since</dt><dd>3.1 </dd></dl> - -</div> -</div> -<a id="abf97ae59c917f9a2856257418dcb1016" name="abf97ae59c917f9a2856257418dcb1016"></a> -<h2 class="memtitle"><span class="permalink"><a href="#abf97ae59c917f9a2856257418dcb1016">◆ </a></span>icalrecur_iterator_set_end()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int icalrecur_iterator_set_end </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> * </td> - <td class="paramname"><em>impl</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td> - <td class="paramname"><em>end</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p >Set the date-time at which the iterator will stop at the latest. Values equal to or greater than end will not be returned by the iterator. </p> - -</div> -</div> -<a id="af830056b191d4e037813ff27c60932cf" name="af830056b191d4e037813ff27c60932cf"></a> -<h2 class="memtitle"><span class="permalink"><a href="#af830056b191d4e037813ff27c60932cf">◆ </a></span>icalrecur_iterator_set_range()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int icalrecur_iterator_set_range </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structicalrecur__iterator__impl.html">icalrecur_iterator</a> * </td> - <td class="paramname"><em>impl</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td> - <td class="paramname"><em>from</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td> - <td class="paramname"><em>to</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p >Sets the date-times over which the iterator will run, where <code>from</code> is a value between DTSTART and UNTIL.</p> -<p >If <code>to</code> is null time, the forward iterator will return values up to and including UNTIL (if present), otherwise up to the year 2582.</p> -<p >if <code>to</code> is non-null time and later than <code>from</code>, the forward iterator will return values up to and including 'to'.</p> -<p >If <code>to</code> is non-null time and earlier than <code>from</code>, the reverse iterator will be set to start at <code>from</code> and will return values down to and including <code>to</code>.</p> -<p >NOTE: CAN NOT be used with RRULEs that contain COUNT. </p><dl class="section since"><dt>Since</dt><dd>3.1 </dd></dl> +<p>Gets the next occurrence from an iterator. </p> </div> </div> -<a id="ab632c95c37375ef11d62d8742e8406d5" name="ab632c95c37375ef11d62d8742e8406d5"></a> +<a id="ab632c95c37375ef11d62d8742e8406d5"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab632c95c37375ef11d62d8742e8406d5">◆ </a></span>icalrecur_iterator_set_start()</h2> <div class="memitem"> @@ -558,12 +450,12 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </tr> </table> </div><div class="memdoc"> -<p >Sets the date-time at which the iterator will start, where <code>start</code> is a value between DTSTART and UNTIL.</p> -<p >NOTE: CAN NOT be used with RRULEs that contain COUNT. </p><dl class="section since"><dt>Since</dt><dd>3.0 </dd></dl> +<p>Sets the date-time at which the iterator will start, where <code>start</code> is a value between DTSTART and UNTIL.</p> +<p>NOTE: CAN NOT be used with RRULEs that contain COUNT. </p><dl class="section since"><dt>Since</dt><dd>3.0 </dd></dl> </div> </div> -<a id="a96c160e7e6b16e0e369c540f2ee164c7" name="a96c160e7e6b16e0e369c540f2ee164c7"></a> +<a id="a96c160e7e6b16e0e369c540f2ee164c7"></a> <h2 class="memtitle"><span class="permalink"><a href="#a96c160e7e6b16e0e369c540f2ee164c7">◆ </a></span>icalrecurrencetype_day_day_of_week()</h2> <div class="memitem"> @@ -582,12 +474,11 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc <p>Decodes a day to a weekday. </p> <dl class="section return"><dt>Returns</dt><dd>The decoded day of the week. 1 is Monday, 2 is Tuesday, etc. A position of 0 means 'any' or 'every'.</dd></dl> <p>The 'day' element of icalrecurrencetype_weekday is encoded to allow representation of both the day of the week ( Monday, Tuesday), but also the Nth day of the week ( First tuesday of the month, last thursday of the year) These routines decode the day values.</p> -<p >The day's position in the period ( Nth-ness) and the numerical value of the day are encoded together as: pos*7 + dow.</p> -<p >A position of 0 means 'any' or 'every'. </p> +<p>The day's position in the period ( Nth-ness) and the numerical value of the day are encoded together as: pos*7 + dow. </p> </div> </div> -<a id="aa730e9ac327064456902076b718400f4" name="aa730e9ac327064456902076b718400f4"></a> +<a id="aa730e9ac327064456902076b718400f4"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa730e9ac327064456902076b718400f4">◆ </a></span>icalrecurrencetype_day_position()</h2> <div class="memitem"> @@ -608,65 +499,7 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </div> </div> -<a id="a1de1894ce541ebf3d5a3cbaf6c5978e1" name="a1de1894ce541ebf3d5a3cbaf6c5978e1"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a1de1894ce541ebf3d5a3cbaf6c5978e1">◆ </a></span>icalrecurrencetype_encode_day()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">short icalrecurrencetype_encode_day </td> - <td>(</td> - <td class="paramtype">enum icalrecurrencetype_weekday </td> - <td class="paramname"><em>weekday</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>position</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p >Encodes the <code>weekday</code> and <code>position</code> into a form, which can be stored to <a class="el" href="structicalrecurrencetype.html#abf0eb04e3bb9028e18c9c4c1e0462b9d" title="Encoded value.">icalrecurrencetype::by_day</a> array. Use <a class="el" href="icalrecur_8h.html#a96c160e7e6b16e0e369c540f2ee164c7" title="Decodes a day to a weekday.">icalrecurrencetype_day_day_of_week()</a> and <a class="el" href="icalrecur_8h.html#aa730e9ac327064456902076b718400f4" title="Decodes a day to a position of the weekday.">icalrecurrencetype_day_position()</a> to split the encoded value back into the parts. </p><dl class="section since"><dt>Since</dt><dd>3.1 </dd></dl> - -</div> -</div> -<a id="aa9d7b1ae411cd1eeb7464ee481e1609b" name="aa9d7b1ae411cd1eeb7464ee481e1609b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aa9d7b1ae411cd1eeb7464ee481e1609b">◆ </a></span>icalrecurrencetype_encode_month()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">short icalrecurrencetype_encode_month </td> - <td>(</td> - <td class="paramtype">int </td> - <td class="paramname"><em>month</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>is_leap</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p >Encodes the <code>month</code> and the <code>is_leap</code> into a form, which can be stored to <a class="el" href="structicalrecurrencetype.html#af3f6d789f51c7772879b6c8e3101af9e" title="Encoded value.">icalrecurrencetype::by_month</a> array. Use <a class="el" href="icalrecur_8h.html#a37565d0a4c56c67bd08b556d58f59b5c">icalrecurrencetype_month_is_leap()</a> and icalrecurrencetype_month_month() to split the encoded value back into the parts </p><dl class="section since"><dt>Since</dt><dd>3.1 </dd></dl> - -</div> -</div> -<a id="a0e8ebcf355ba22299f553f8f5e657926" name="a0e8ebcf355ba22299f553f8f5e657926"></a> +<a id="a0e8ebcf355ba22299f553f8f5e657926"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0e8ebcf355ba22299f553f8f5e657926">◆ </a></span>icalrecurrencetype_from_string()</h2> <div class="memitem"> @@ -681,34 +514,14 @@ int </td><td class="memItemRight" valign="bottom"><b>icalrecurrencetype_rsc </tr> </table> </div><div class="memdoc"> -<p >Convert between strings and recurrencetype structures. </p> - -</div> -</div> -<a id="a37565d0a4c56c67bd08b556d58f59b5c" name="a37565d0a4c56c67bd08b556d58f59b5c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a37565d0a4c56c67bd08b556d58f59b5c">◆ </a></span>icalrecurrencetype_month_is_leap()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int icalrecurrencetype_month_is_leap </td> - <td>(</td> - <td class="paramtype">short </td> - <td class="paramname"><em>month</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p >The <code>month</code> element of the by_month array is encoded to allow representation of the "L" leap suffix (RFC 7529). These routines decode the month values.</p> -<p >The "L" suffix is encoded by setting a high-order bit. </p> +<p>Convert between strings and recurrencetype structures. </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> |