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
|
<!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: icalvalue.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">icalvalue.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="icalvalue_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> <span class="comment">/*======================================================================</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> FILE: icalvalue.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 ICALVALUE_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define ICALVALUE_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 "icalvalueimpl.h"</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define ICAL_BOOLEAN_TRUE 1</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define ICAL_BOOLEAN_FALSE 0</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new(icalvalue_kind kind);</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> LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new_clone(<span class="keyword">const</span> icalvalue *value);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new_from_string(icalvalue_kind kind, <span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> icalvalue_free(icalvalue *value);</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> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icalvalue_is_valid(<span class="keyword">const</span> icalvalue *value);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icalvalue_as_ical_string(<span class="keyword">const</span> icalvalue *value);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalvalue_as_ical_string_r(<span class="keyword">const</span> icalvalue *value);</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> LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_isa(<span class="keyword">const</span> icalvalue *value);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> icalvalue_isa_value(<span class="keywordtype">void</span> *);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> LIBICAL_ICAL_EXPORT icalparameter_xliccomparetype icalvalue_compare(<span class="keyword">const</span> icalvalue *a,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">const</span> icalvalue *b);</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> <span class="comment">/* Special, non autogenerated value accessors */</span></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">/* Defined in icalderivedvalue.h */</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/* icalvalue* icalvalue_new_recur (struct icalrecurrencetype v); */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/* void icalvalue_set_recur(icalvalue* value, struct icalrecurrencetype v); */</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/* struct icalrecurrencetype icalvalue_get_recur(const icalvalue* value); */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/* icalvalue* icalvalue_new_trigger (struct icaltriggertype v); */</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/* void icalvalue_set_trigger(icalvalue* value, struct icaltriggertype v); */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/* struct icaltriggertype icalvalue_get_trigger(const icalvalue* value); */</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/* icalvalue* icalvalue_new_datetimeperiod (struct icaldatetimeperiodtype v); */</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/* void icalvalue_set_datetimeperiod(icalvalue* value, */</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/* struct icaldatetimeperiodtype v); */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/* struct icaldatetimeperiodtype icalvalue_get_datetimeperiod(const icalvalue* value); */</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/* Convert enumerations */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_string_to_kind(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</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">const</span> <span class="keywordtype">char</span> *icalvalue_kind_to_string(<span class="keyword">const</span> icalvalue_kind kind);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="icalvalue_8h.html#ada00c51fccf5a71ec7e43fb6207b634a"> 74</a></span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalvalue_8h.html#ada00c51fccf5a71ec7e43fb6207b634a">icalvalue_kind_is_valid</a>(<span class="keyword">const</span> icalvalue_kind kind);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalvalue_8h.html#a47037dfa87d634a358c39055c01b9f79">icalvalue_encode_ical_string</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *szText,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">char</span> *szEncText, <span class="keywordtype">int</span> MaxBufferLen);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalvalue_8h.html#ad809218d40ebb1e356f00c563e34e3d6">icalvalue_decode_ical_string</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *szText,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">char</span> *szDecText, <span class="keywordtype">int</span> nMaxBufferLen);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/* For the library only -- do not make visible */</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">extern</span> <span class="keywordtype">void</span> print_date_to_string(<span class="keywordtype">char</span> *str, <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structicaltimetype.html">icaltimetype</a> *data);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">extern</span> <span class="keywordtype">void</span> print_datetime_to_string(<span class="keywordtype">char</span> *str, <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structicaltimetype.html">icaltimetype</a> *data);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif </span><span class="comment">/*ICALVALUE_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aicalvalue_8h_html_a47037dfa87d634a358c39055c01b9f79"><div class="ttname"><a href="icalvalue_8h.html#a47037dfa87d634a358c39055c01b9f79">icalvalue_encode_ical_string</a></div><div class="ttdeci">int icalvalue_encode_ical_string(const char *szText, char *szEncText, int MaxBufferLen)</div><div class="ttdef"><b>Definition:</b> icalvalue.c:1483</div></div>
<div class="ttc" id="aicalvalue_8h_html_ad809218d40ebb1e356f00c563e34e3d6"><div class="ttname"><a href="icalvalue_8h.html#ad809218d40ebb1e356f00c563e34e3d6">icalvalue_decode_ical_string</a></div><div class="ttdeci">int icalvalue_decode_ical_string(const char *szText, char *szDecText, int nMaxBufferLen)</div><div class="ttdef"><b>Definition:</b> icalvalue.c:1514</div></div>
<div class="ttc" id="aicalvalue_8h_html_ada00c51fccf5a71ec7e43fb6207b634a"><div class="ttname"><a href="icalvalue_8h.html#ada00c51fccf5a71ec7e43fb6207b634a">icalvalue_kind_is_valid</a></div><div class="ttdeci">int icalvalue_kind_is_valid(const icalvalue_kind kind)</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 --></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>
|
