summaryrefslogtreecommitdiff
path: root/apidocs/icalrestriction_8h_source.html
blob: 1687fcfe93a2a878f3ed8b185359dbc53ea276be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<!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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icalrestriction.h Source File</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
   &#160;<span id="projectnumber">3.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">icalrestriction.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="icalrestriction_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*======================================================================</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">  FILE: icalrestriction.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">  CREATOR: eric 24 April 1999</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> (C) COPYRIGHT 2000, Eric Busboom &lt;eric@civicknowledge.com&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> This library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> it under the terms of either:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">    The LGPL as published by the Free Software Foundation, version</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">    2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> Or:</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    The Mozilla Public License Version 2.0. You may obtain a copy of</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">    the License at https://www.mozilla.org/MPL/</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> The original code is icalrestriction.h</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> Contributions from:</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">    Graham Davison (g.m.davison@computer.org)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">======================================================================*/</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#ifndef ICALRESTRICTION_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#define ICALRESTRICTION_H</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &quot;libical_ical_export.h&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="icalcomponent_8h.html">icalcomponent.h</a>&quot;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="icalproperty_8h.html">icalproperty.h</a>&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">   42</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;{</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a8919e63bb091b6a78f508a212e3d2a36">   45</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a8919e63bb091b6a78f508a212e3d2a36">ICAL_RESTRICTION_NONE</a> = 0, <span class="comment">/* 0 */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aace01bc6164411a18933716916c6c7ef">   48</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aace01bc6164411a18933716916c6c7ef">ICAL_RESTRICTION_ZERO</a>, <span class="comment">/* 1 */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a4bc2d60b26b48e795abf26e05dd2fe17">   51</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a4bc2d60b26b48e795abf26e05dd2fe17">ICAL_RESTRICTION_ONE</a>, <span class="comment">/* 2 */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a15c781ad15f9a8392a620559c278199e">   54</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a15c781ad15f9a8392a620559c278199e">ICAL_RESTRICTION_ZEROPLUS</a>, <span class="comment">/* 3 */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a772dd4b4cdfe5d5a264ec237a63e6c21">   57</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a772dd4b4cdfe5d5a264ec237a63e6c21">ICAL_RESTRICTION_ONEPLUS</a>, <span class="comment">/* 4 */</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a941349ba77c59b895acc1f7133421a94">   60</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a941349ba77c59b895acc1f7133421a94">ICAL_RESTRICTION_ZEROORONE</a>, <span class="comment">/* 5 */</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a6689f5056a7239a1f7d90eed1697d4f9">   63</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a6689f5056a7239a1f7d90eed1697d4f9">ICAL_RESTRICTION_ONEEXCLUSIVE</a>, <span class="comment">/* 6 */</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aa27388029f05e9a1fae601d0ccbf69d9">   66</a></span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aa27388029f05e9a1fae601d0ccbf69d9">ICAL_RESTRICTION_ONEMUTUAL</a>, <span class="comment">/* 7 */</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a166b57120ae7e1f7b2d321d36bbb7bce">ICAL_RESTRICTION_UNKNOWN</a>    <span class="comment">/* 8 */</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#ae380f8acbf3acc9650130ce17aa755f9">   70</a></span>&#160;} <a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a>;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">   85</a></span>&#160;LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">icalrestriction_compare</a>(<a class="code" href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a> restr, <span class="keywordtype">int</span> count);</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="icalrestriction_8h.html#a36eeedfdce2344da44fd09d9e3f18b57">  105</a></span>&#160;LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalrestriction_8h.html#a36eeedfdce2344da44fd09d9e3f18b57">icalrestriction_check</a>(<a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !ICALRESTRICTION_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<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="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1a941349ba77c59b895acc1f7133421a94"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a941349ba77c59b895acc1f7133421a94">ICAL_RESTRICTION_ZEROORONE</a></div><div class="ttdeci">@ ICAL_RESTRICTION_ZEROORONE</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:60</div></div>
<div class="ttc" id="aicalproperty_8h_html"><div class="ttname"><a href="icalproperty_8h.html">icalproperty.h</a></div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1a15c781ad15f9a8392a620559c278199e"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a15c781ad15f9a8392a620559c278199e">ICAL_RESTRICTION_ZEROPLUS</a></div><div class="ttdeci">@ ICAL_RESTRICTION_ZEROPLUS</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:54</div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1">icalrestriction_kind</a></div><div class="ttdeci">icalrestriction_kind</div><div class="ttdoc">The kinds of icalrestrictions there are.</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:43</div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1a166b57120ae7e1f7b2d321d36bbb7bce"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a166b57120ae7e1f7b2d321d36bbb7bce">ICAL_RESTRICTION_UNKNOWN</a></div><div class="ttdeci">@ ICAL_RESTRICTION_UNKNOWN</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:69</div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1a4bc2d60b26b48e795abf26e05dd2fe17"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a4bc2d60b26b48e795abf26e05dd2fe17">ICAL_RESTRICTION_ONE</a></div><div class="ttdeci">@ ICAL_RESTRICTION_ONE</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:51</div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1aa27388029f05e9a1fae601d0ccbf69d9"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aa27388029f05e9a1fae601d0ccbf69d9">ICAL_RESTRICTION_ONEMUTUAL</a></div><div class="ttdeci">@ ICAL_RESTRICTION_ONEMUTUAL</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:66</div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1a8919e63bb091b6a78f508a212e3d2a36"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a8919e63bb091b6a78f508a212e3d2a36">ICAL_RESTRICTION_NONE</a></div><div class="ttdeci">@ ICAL_RESTRICTION_NONE</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:45</div></div>
<div class="ttc" id="aicalcomponent_8h_html"><div class="ttname"><a href="icalcomponent_8h.html">icalcomponent.h</a></div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1a6689f5056a7239a1f7d90eed1697d4f9"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a6689f5056a7239a1f7d90eed1697d4f9">ICAL_RESTRICTION_ONEEXCLUSIVE</a></div><div class="ttdeci">@ ICAL_RESTRICTION_ONEEXCLUSIVE</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:63</div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1aace01bc6164411a18933716916c6c7ef"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1aace01bc6164411a18933716916c6c7ef">ICAL_RESTRICTION_ZERO</a></div><div class="ttdeci">@ ICAL_RESTRICTION_ZERO</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:48</div></div>
<div class="ttc" id="aicalrestriction_8h_html_ac6d836f345770d880b446d964f685db1a772dd4b4cdfe5d5a264ec237a63e6c21"><div class="ttname"><a href="icalrestriction_8h.html#ac6d836f345770d880b446d964f685db1a772dd4b4cdfe5d5a264ec237a63e6c21">ICAL_RESTRICTION_ONEPLUS</a></div><div class="ttdeci">@ ICAL_RESTRICTION_ONEPLUS</div><div class="ttdef"><b>Definition:</b> icalrestriction.h:57</div></div>
<div class="ttc" id="aicalrestriction_8h_html_acd3882ab8b58bf0e12cb9ed48234ce2d"><div class="ttname"><a href="icalrestriction_8h.html#acd3882ab8b58bf0e12cb9ed48234ce2d">icalrestriction_compare</a></div><div class="ttdeci">int icalrestriction_compare(icalrestriction_kind restr, int count)</div><div class="ttdoc">Checks if the given count is in accordance with the given restriction, restr.</div></div>
<div class="ttc" id="aicalrestriction_8h_html_a36eeedfdce2344da44fd09d9e3f18b57"><div class="ttname"><a href="icalrestriction_8h.html#a36eeedfdce2344da44fd09d9e3f18b57">icalrestriction_check</a></div><div class="ttdeci">int icalrestriction_check(icalcomponent *comp)</div><div class="ttdoc">Checks if a given VCALENDAR meets all the restrictions imposed by the standard.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 16 2021 17:20:59 for Libical API Documentation by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>