diff options
Diffstat (limited to 'apidocs/structicalrecurrencetype.html')
-rw-r--r-- | apidocs/structicalrecurrencetype.html | 171 |
1 files changed, 171 insertions, 0 deletions
diff --git a/apidocs/structicalrecurrencetype.html b/apidocs/structicalrecurrencetype.html new file mode 100644 index 00000000..d7d15ae5 --- /dev/null +++ b/apidocs/structicalrecurrencetype.html @@ -0,0 +1,171 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Libical API Documentation: icalrecurrencetype Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Libical API Documentation +  <span id="projectnumber">3.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">icalrecurrencetype Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Data Fields</h2></td></tr> +<tr class="memitem:abf0eb04e3bb9028e18c9c4c1e0462b9d"><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="structicalrecurrencetype.html#abf0eb04e3bb9028e18c9c4c1e0462b9d">by_day</a> [7 *(56 -1)+1]</td></tr> +<tr class="memdesc:abf0eb04e3bb9028e18c9c4c1e0462b9d"><td class="mdescLeft"> </td><td class="mdescRight">Encoded value. <a href="structicalrecurrencetype.html#abf0eb04e3bb9028e18c9c4c1e0462b9d">More...</a><br /></td></tr> +<tr class="separator:abf0eb04e3bb9028e18c9c4c1e0462b9d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab6724a6b2854c6c338bd27933ba7f2c5"><td class="memItemLeft" align="right" valign="top"><a id="ab6724a6b2854c6c338bd27933ba7f2c5"></a> +short </td><td class="memItemRight" valign="bottom"><b>by_hour</b> [25]</td></tr> +<tr class="separator:ab6724a6b2854c6c338bd27933ba7f2c5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a891efe618a2dcfa53b227fb1fed14d13"><td class="memItemLeft" align="right" valign="top"><a id="a891efe618a2dcfa53b227fb1fed14d13"></a> +short </td><td class="memItemRight" valign="bottom"><b>by_minute</b> [61]</td></tr> +<tr class="separator:a891efe618a2dcfa53b227fb1fed14d13"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af3f6d789f51c7772879b6c8e3101af9e"><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="structicalrecurrencetype.html#af3f6d789f51c7772879b6c8e3101af9e">by_month</a> [14]</td></tr> +<tr class="memdesc:af3f6d789f51c7772879b6c8e3101af9e"><td class="mdescLeft"> </td><td class="mdescRight">Encoded value. <a href="structicalrecurrencetype.html#af3f6d789f51c7772879b6c8e3101af9e">More...</a><br /></td></tr> +<tr class="separator:af3f6d789f51c7772879b6c8e3101af9e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a25d7879b01b0ddebe6e9ee7ad8992f3c"><td class="memItemLeft" align="right" valign="top"><a id="a25d7879b01b0ddebe6e9ee7ad8992f3c"></a> +short </td><td class="memItemRight" valign="bottom"><b>by_month_day</b> [32]</td></tr> +<tr class="separator:a25d7879b01b0ddebe6e9ee7ad8992f3c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2d3e214d39a60522bb915ab0639a18ac"><td class="memItemLeft" align="right" valign="top"><a id="a2d3e214d39a60522bb915ab0639a18ac"></a> +short </td><td class="memItemRight" valign="bottom"><b>by_second</b> [62]</td></tr> +<tr class="separator:a2d3e214d39a60522bb915ab0639a18ac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad4296efee2c4893a20c92001b3f05218"><td class="memItemLeft" align="right" valign="top"><a id="ad4296efee2c4893a20c92001b3f05218"></a> +short </td><td class="memItemRight" valign="bottom"><b>by_set_pos</b> [386]</td></tr> +<tr class="separator:ad4296efee2c4893a20c92001b3f05218"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aed627ce7e4c3e18db6b29a42016119c0"><td class="memItemLeft" align="right" valign="top"><a id="aed627ce7e4c3e18db6b29a42016119c0"></a> +short </td><td class="memItemRight" valign="bottom"><b>by_week_no</b> [56]</td></tr> +<tr class="separator:aed627ce7e4c3e18db6b29a42016119c0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac5e0e5e430a036b496e03ecfeb8f1397"><td class="memItemLeft" align="right" valign="top"><a id="ac5e0e5e430a036b496e03ecfeb8f1397"></a> +short </td><td class="memItemRight" valign="bottom"><b>by_year_day</b> [386]</td></tr> +<tr class="separator:ac5e0e5e430a036b496e03ecfeb8f1397"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afee9e52f7560625551ed725595ece3e8"><td class="memItemLeft" align="right" valign="top"><a id="afee9e52f7560625551ed725595ece3e8"></a> +int </td><td class="memItemRight" valign="bottom"><b>count</b></td></tr> +<tr class="separator:afee9e52f7560625551ed725595ece3e8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4dfb35662209ee3ade1ce4960d9abb1c"><td class="memItemLeft" align="right" valign="top"><a id="a4dfb35662209ee3ade1ce4960d9abb1c"></a> +icalrecurrencetype_frequency </td><td class="memItemRight" valign="bottom"><b>freq</b></td></tr> +<tr class="separator:a4dfb35662209ee3ade1ce4960d9abb1c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a33830e83012e14b7246f6d4ca969c4a0"><td class="memItemLeft" align="right" valign="top"><a id="a33830e83012e14b7246f6d4ca969c4a0"></a> +short </td><td class="memItemRight" valign="bottom"><b>interval</b></td></tr> +<tr class="separator:a33830e83012e14b7246f6d4ca969c4a0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aebf890217d8c2726fe8e339cd1b2e248"><td class="memItemLeft" align="right" valign="top"><a id="aebf890217d8c2726fe8e339cd1b2e248"></a> +char * </td><td class="memItemRight" valign="bottom"><b>rscale</b></td></tr> +<tr class="separator:aebf890217d8c2726fe8e339cd1b2e248"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa4f85d84dfa254ca0de3dfec85988e85"><td class="memItemLeft" align="right" valign="top"><a id="aa4f85d84dfa254ca0de3dfec85988e85"></a> +icalrecurrencetype_skip </td><td class="memItemRight" valign="bottom"><b>skip</b></td></tr> +<tr class="separator:aa4f85d84dfa254ca0de3dfec85988e85"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aee2f594797f65bcb278fcc325617330f"><td class="memItemLeft" align="right" valign="top"><a id="aee2f594797f65bcb278fcc325617330f"></a> +struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td><td class="memItemRight" valign="bottom"><b>until</b></td></tr> +<tr class="separator:aee2f594797f65bcb278fcc325617330f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab7abcfded11855eeedcfdef6222783e5"><td class="memItemLeft" align="right" valign="top"><a id="ab7abcfded11855eeedcfdef6222783e5"></a> +icalrecurrencetype_weekday </td><td class="memItemRight" valign="bottom"><b>week_start</b></td></tr> +<tr class="separator:ab7abcfded11855eeedcfdef6222783e5"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Main struct for holding digested recurrence rules </p> +</div><h2 class="groupheader">Field Documentation</h2> +<a id="abf0eb04e3bb9028e18c9c4c1e0462b9d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abf0eb04e3bb9028e18c9c4c1e0462b9d">◆ </a></span>by_day</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">short icalrecurrencetype::by_day[7 *(56 -1)+1]</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Encoded value. </p> +<p>The 'day' element of the by_day array 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).</p> +<p>These values are decoded by <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>. </p> + +</div> +</div> +<a id="af3f6d789f51c7772879b6c8e3101af9e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af3f6d789f51c7772879b6c8e3101af9e">◆ </a></span>by_month</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">short icalrecurrencetype::by_month[14]</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Encoded value. </p> +<p>The 'month' element of the by_month array is encoded to allow representation of the "L" leap suffix (RFC 7529).</p> +<p>These values are decoded by icalrecurrencetype_month_is_leap() and icalrecurrencetype_month_month(). </p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="icalrecur_8h_source.html">icalrecur.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Thu Oct 6 2022 11:56:07 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> |