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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<!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: icaltypes.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
 <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 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">icaltypes.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*======================================================================</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> FILE: icaltypes.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> CREATOR: eric 20 March 1999</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span> </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment"> it under the terms of either:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <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> <span class="comment"></span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Or:</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <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> <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> <span class="comment">======================================================================*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef ICALTYPES_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define ICALTYPES_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "libical_ical_export.h"</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="icalduration_8h.html">icalduration.h</a>"</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="icalenums_8h.html">icalenums.h</a>"</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="icalperiod_8h.html">icalperiod.h</a>"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structicaldatetimeperiodtype.html"> 27</a></span> <span class="keyword">struct </span><a class="code" href="structicaldatetimeperiodtype.html">icaldatetimeperiodtype</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> time;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> };</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structicalgeotype.html"> 33</a></span> <span class="keyword">struct </span><a class="code" href="structicalgeotype.html">icalgeotype</a></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">double</span> lat;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">double</span> lon;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> };</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structicaltriggertype.html"> 39</a></span> <span class="keyword">struct </span><a class="code" href="structicaltriggertype.html">icaltriggertype</a></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> time;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> };</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaltriggertype.html">icaltriggertype</a> icaltriggertype_from_int(const int reltime);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaltriggertype.html">icaltriggertype</a> icaltriggertype_from_string(const char *str);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icaltriggertype_is_null_trigger(<span class="keyword">struct</span> <a class="code" href="structicaltriggertype.html">icaltriggertype</a> tr);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icaltriggertype_is_bad_trigger(<span class="keyword">struct</span> <a class="code" href="structicaltriggertype.html">icaltriggertype</a> tr);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/* struct icalreqstattype. This struct contains two string pointers,</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">but don't try to free either of them. The "desc" string is a pointer</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">to a static table inside the library. Don't try to free it. The</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">"debug" string is a pointer into the string that the called passed</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">into to icalreqstattype_from_string. Don't try to free it either, and</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">don't use it after the original string has been freed.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">BTW, you would get that original string from</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">*icalproperty_get_requeststatus() or icalvalue_get_text(), when</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">operating on the value of a request_status property. */</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structicalreqstattype.html"> 64</a></span> <span class="keyword">struct </span><a class="code" href="structicalreqstattype.html">icalreqstattype</a></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  icalrequeststatus code;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *desc;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *debug;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicalreqstattype.html">icalreqstattype</a> icalreqstattype_from_string(const char *str);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalreqstattype_as_string(<span class="keyword">struct</span> <a class="code" href="structicalreqstattype.html">icalreqstattype</a>);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalreqstattype_as_string_r(<span class="keyword">struct</span> <a class="code" href="structicalreqstattype.html">icalreqstattype</a>);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structicaltimezonephase.html"> 77</a></span> <span class="keyword">struct </span><a class="code" href="structicaltimezonephase.html">icaltimezonephase</a></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *tzname;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">int</span> is_stdandard; <span class="comment">/* 1 = standard tme, 0 = daylight savings time */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> dtstart;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">int</span> offsetto;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> tzoffsetfrom;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *comment;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">struct </span><a class="code" href="structicaldatetimeperiodtype.html">icaldatetimeperiodtype</a> <a class="code" href="structrdate.html">rdate</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *rrule;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structicaltimezonetype.html"> 89</a></span> <span class="keyword">struct </span><a class="code" href="structicaltimezonetype.html">icaltimezonetype</a></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *tzid;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> last_mod;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *tzurl;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">/* Array of phases. The end of the array is a phase with tzname == 0 */</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">struct </span><a class="code" href="structicaltimezonephase.html">icaltimezonephase</a> *phases;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">/* ical_unknown_token_handling :</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * How should the ICAL library handle components, properties and parameters with</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * unknown names?</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * FIXME: Currently only affects parameters. Extend to components and properties.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> ical_unknown_token_handling</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  ICAL_ASSUME_IANA_TOKEN = 1,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  ICAL_DISCARD_TOKEN = 2,</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  ICAL_TREAT_AS_ERROR = 3</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> } ical_unknown_token_handling;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> LIBICAL_ICAL_EXPORT ical_unknown_token_handling ical_get_unknown_token_handling_setting(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> ical_set_unknown_token_handling_setting(</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  ical_unknown_token_handling newSetting);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#endif </span><span class="comment">/* !ICALTYPES_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aicalduration_8h_html"><div class="ttname"><a href="icalduration_8h.html">icalduration.h</a></div><div class="ttdoc">Methods for working with durations in iCal.</div></div>
<div class="ttc" id="aicalenums_8h_html"><div class="ttname"><a href="icalenums_8h.html">icalenums.h</a></div></div>
<div class="ttc" id="aicalperiod_8h_html"><div class="ttname"><a href="icalperiod_8h.html">icalperiod.h</a></div><div class="ttdoc">Functions for working with iCal periods (of time).</div></div>
<div class="ttc" id="astructicaldatetimeperiodtype_html"><div class="ttname"><a href="structicaldatetimeperiodtype.html">icaldatetimeperiodtype</a></div><div class="ttdef"><b>Definition:</b> icaltypes.h:28</div></div>
<div class="ttc" id="astructicaldurationtype_html"><div class="ttname"><a href="structicaldurationtype.html">icaldurationtype</a></div><div class="ttdoc">A struct representing a duration.</div><div class="ttdef"><b>Definition:</b> icalduration.h:37</div></div>
<div class="ttc" id="astructicalgeotype_html"><div class="ttname"><a href="structicalgeotype.html">icalgeotype</a></div><div class="ttdef"><b>Definition:</b> icaltypes.h:34</div></div>
<div class="ttc" id="astructicalperiodtype_html"><div class="ttname"><a href="structicalperiodtype.html">icalperiodtype</a></div><div class="ttdoc">Struct to represent a period in time.</div><div class="ttdef"><b>Definition:</b> icalperiod.h:38</div></div>
<div class="ttc" id="astructicalreqstattype_html"><div class="ttname"><a href="structicalreqstattype.html">icalreqstattype</a></div><div class="ttdef"><b>Definition:</b> icaltypes.h:65</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 class="ttc" id="astructicaltimezonephase_html"><div class="ttname"><a href="structicaltimezonephase.html">icaltimezonephase</a></div><div class="ttdef"><b>Definition:</b> icaltypes.h:78</div></div>
<div class="ttc" id="astructicaltimezonetype_html"><div class="ttname"><a href="structicaltimezonetype.html">icaltimezonetype</a></div><div class="ttdef"><b>Definition:</b> icaltypes.h:90</div></div>
<div class="ttc" id="astructicaltriggertype_html"><div class="ttname"><a href="structicaltriggertype.html">icaltriggertype</a></div><div class="ttdef"><b>Definition:</b> icaltypes.h:40</div></div>
<div class="ttc" id="astructrdate_html"><div class="ttname"><a href="structrdate.html">rdate</a></div><div class="ttdef"><b>Definition:</b> icaltimezone.c:2206</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 6 2022 14:47:00 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>
|
