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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<!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: icaldirset.h File 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 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_e5788c73bf8d77f47d4a3002d26bfd20.html">libicalss</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">icaldirset.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>icaldirset manages a database of ical components and offers interfaces for reading, writing and searching for components.
<a href="#details">More...</a></p>
<p><a href="icaldirset_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 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="structicaldirset__options.html">icaldirset_options</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 name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae7712b1a5506b62af79f3e6e4ba2a409"><td class="memItemLeft" align="right" valign="top"><a id="ae7712b1a5506b62af79f3e6e4ba2a409"></a>
typedef struct <a class="el" href="structicaldirset__impl.html">icaldirset_impl</a> </td><td class="memItemRight" valign="bottom"><b>icaldirset</b></td></tr>
<tr class="separator:ae7712b1a5506b62af79f3e6e4ba2a409"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41b5afef5f485092ae5a81b4ac9681c2"><td class="memItemLeft" align="right" valign="top"><a id="a41b5afef5f485092ae5a81b4ac9681c2"></a>
typedef struct <a class="el" href="structicaldirset__options.html">icaldirset_options</a> </td><td class="memItemRight" valign="bottom"><b>icaldirset_options</b></td></tr>
<tr class="separator:a41b5afef5f485092ae5a81b4ac9681c2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a123ff2d1b0887caafc027936bc9b921b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icaldirset_8h.html#a123ff2d1b0887caafc027936bc9b921b">icaldirset_add_component</a> (<a class="el" href="structicalset__impl.html">icalset</a> *store, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr>
<tr class="separator:a123ff2d1b0887caafc027936bc9b921b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d870b03a4552f8fe335dd8599571cb4"><td class="memItemLeft" align="right" valign="top"><a id="a1d870b03a4552f8fe335dd8599571cb4"></a>
<a class="el" href="structicalsetiter.html">icalsetiter</a> </td><td class="memItemRight" valign="bottom"><b>icaldirset_begin_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, icalcomponent_kind kind, <a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge, const char *tzid)</td></tr>
<tr class="separator:a1d870b03a4552f8fe335dd8599571cb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad13d7dc78588fc873de1306838bccbe7"><td class="memItemLeft" align="right" valign="top"><a id="ad13d7dc78588fc873de1306838bccbe7"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaldirset_clear</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store)</td></tr>
<tr class="separator:ad13d7dc78588fc873de1306838bccbe7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5366244e9deac9d1737bf72b1aa2bdc3"><td class="memItemLeft" align="right" valign="top"><a id="a5366244e9deac9d1737bf72b1aa2bdc3"></a>
<a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> </td><td class="memItemRight" valign="bottom"><b>icaldirset_commit</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr>
<tr class="separator:a5366244e9deac9d1737bf72b1aa2bdc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe8a404b585e994f17854089c716e7fa"><td class="memItemLeft" align="right" valign="top"><a id="afe8a404b585e994f17854089c716e7fa"></a>
int </td><td class="memItemRight" valign="bottom"><b>icaldirset_count_components</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store, icalcomponent_kind kind)</td></tr>
<tr class="separator:afe8a404b585e994f17854089c716e7fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a585858d6fbdaa25a2f63deb123186a2d"><td class="memItemLeft" align="right" valign="top"><a id="a585858d6fbdaa25a2f63deb123186a2d"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_fetch</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store, icalcomponent_kind kind, const char *uid)</td></tr>
<tr class="separator:a585858d6fbdaa25a2f63deb123186a2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73136ee2e5cd70fb8e79474677e3fb5a"><td class="memItemLeft" align="right" valign="top"><a id="a73136ee2e5cd70fb8e79474677e3fb5a"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_fetch_match</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *c)</td></tr>
<tr class="separator:a73136ee2e5cd70fb8e79474677e3fb5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39929ddba9ca8b4c2285119e1d5b9564"><td class="memItemLeft" align="right" valign="top"><a id="a39929ddba9ca8b4c2285119e1d5b9564"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaldirset_free</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr>
<tr class="separator:a39929ddba9ca8b4c2285119e1d5b9564"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a727ec5e6ac614c71cc8ac6392efc6601"><td class="memItemLeft" align="right" valign="top"><a id="a727ec5e6ac614c71cc8ac6392efc6601"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_get_current_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store)</td></tr>
<tr class="separator:a727ec5e6ac614c71cc8ac6392efc6601"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af916c63fa87ee3ab119d165daa4bfd29"><td class="memItemLeft" align="right" valign="top"><a id="af916c63fa87ee3ab119d165daa4bfd29"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_get_first_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store)</td></tr>
<tr class="separator:af916c63fa87ee3ab119d165daa4bfd29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8c11a111b8ff48ccef76fdf47803c99"><td class="memItemLeft" align="right" valign="top"><a id="ae8c11a111b8ff48ccef76fdf47803c99"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_get_next_component</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store)</td></tr>
<tr class="separator:ae8c11a111b8ff48ccef76fdf47803c99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3cab1bc41714f86a4c8b546c951c647"><td class="memItemLeft" align="right" valign="top"><a id="aa3cab1bc41714f86a4c8b546c951c647"></a>
int </td><td class="memItemRight" valign="bottom"><b>icaldirset_has_uid</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store, const char *uid)</td></tr>
<tr class="separator:aa3cab1bc41714f86a4c8b546c951c647"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa44f0597ffbe2e99609e1c89381d2e53"><td class="memItemLeft" align="right" valign="top"><a id="aa44f0597ffbe2e99609e1c89381d2e53"></a>
<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_init</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, const char *dsn, void *options)</td></tr>
<tr class="separator:aa44f0597ffbe2e99609e1c89381d2e53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85969c454f8939d980d34042c6dcc567"><td class="memItemLeft" align="right" valign="top"><a id="a85969c454f8939d980d34042c6dcc567"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaldirset_mark</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr>
<tr class="separator:a85969c454f8939d980d34042c6dcc567"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af38c375c926aa41ba587b9043aaa49eb"><td class="memItemLeft" align="right" valign="top"><a id="af38c375c926aa41ba587b9043aaa49eb"></a>
<a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> </td><td class="memItemRight" valign="bottom"><b>icaldirset_modify</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *oldc, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *newc)</td></tr>
<tr class="separator:af38c375c926aa41ba587b9043aaa49eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a313c50d240f600856b2aaf4b9abc0b61"><td class="memItemLeft" align="right" valign="top"><a id="a313c50d240f600856b2aaf4b9abc0b61"></a>
<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_new</b> (const char *path)</td></tr>
<tr class="separator:a313c50d240f600856b2aaf4b9abc0b61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac38ab74a789f4b61c7dcca669625bc2"><td class="memItemLeft" align="right" valign="top"><a id="aac38ab74a789f4b61c7dcca669625bc2"></a>
<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_new_reader</b> (const char *path)</td></tr>
<tr class="separator:aac38ab74a789f4b61c7dcca669625bc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b15306a6dc7ba66877a48ff0ce21d5a"><td class="memItemLeft" align="right" valign="top"><a id="a6b15306a6dc7ba66877a48ff0ce21d5a"></a>
<a class="el" href="structicalset__impl.html">icalset</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirset_new_writer</b> (const char *path)</td></tr>
<tr class="separator:a6b15306a6dc7ba66877a48ff0ce21d5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b463342edfd579041d52428b6d5c040"><td class="memItemLeft" align="right" valign="top"><a id="a6b463342edfd579041d52428b6d5c040"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>icaldirset_path</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set)</td></tr>
<tr class="separator:a6b463342edfd579041d52428b6d5c040"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3b06ab0380ffb7c0e4b7ce9251931ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icaldirset_8h.html#ae3b06ab0380ffb7c0e4b7ce9251931ad">icaldirset_remove_component</a> (<a class="el" href="structicalset__impl.html">icalset</a> *store, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr>
<tr class="separator:ae3b06ab0380ffb7c0e4b7ce9251931ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4eaa1b0afc94e4986b5454a03c3bd47"><td class="memItemLeft" align="right" valign="top"><a id="ae4eaa1b0afc94e4986b5454a03c3bd47"></a>
<a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> </td><td class="memItemRight" valign="bottom"><b>icaldirset_select</b> (<a class="el" href="structicalset__impl.html">icalset</a> *store, <a class="el" href="structicalgauge__impl.html">icalgauge</a> *gauge)</td></tr>
<tr class="separator:ae4eaa1b0afc94e4986b5454a03c3bd47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89b210141283d6b70140bb1e6621b9fa"><td class="memItemLeft" align="right" valign="top"><a id="a89b210141283d6b70140bb1e6621b9fa"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirsetiter_to_next</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalsetiter.html">icalsetiter</a> *i)</td></tr>
<tr class="separator:a89b210141283d6b70140bb1e6621b9fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc26c32c503ad510972150124fa1383f"><td class="memItemLeft" align="right" valign="top"><a id="abc26c32c503ad510972150124fa1383f"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaldirsetiter_to_prior</b> (<a class="el" href="structicalset__impl.html">icalset</a> *set, <a class="el" href="structicalsetiter.html">icalsetiter</a> *i)</td></tr>
<tr class="separator:abc26c32c503ad510972150124fa1383f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>icaldirset manages a database of ical components and offers interfaces for reading, writing and searching for components. </p>
<p>icaldirset groups components in to clusters based on their DTSTAMP time – all components that start in the same month are grouped together in a single file. All files in a sotre are kept in a single directory.</p>
<p>The primary interfaces are icaldirset__get_first_component and icaldirset_get_next_component. These routine iterate through all of the components in the store, subject to the current gauge. A gauge is an icalcomponent that is tested against other components for a match. If a gauge has been set with icaldirset_select, icaldirset_first and icaldirset_next will only return components that match the gauge.</p>
<p>The Store generated UIDs for all objects that are stored if they do not already have a UID. The UID is the name of the cluster (month & year as MMYYYY) plus a unique serial number. The serial number is stored as a property of the cluster. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a123ff2d1b0887caafc027936bc9b921b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a123ff2d1b0887caafc027936bc9b921b">◆ </a></span>icaldirset_add_component()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_add_component </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td>
<td class="paramname"><em>store</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td>
<td class="paramname"><em>comp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This assumes that the top level component is a VCALENDAR, and there is an inner component of type VEVENT, VTODO or VJOURNAL. The inner component must have a DSTAMP property </p>
</div>
</div>
<a id="ae3b06ab0380ffb7c0e4b7ce9251931ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3b06ab0380ffb7c0e4b7ce9251931ad">◆ </a></span>icaldirset_remove_component()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_remove_component </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td>
<td class="paramname"><em>set</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td>
<td class="paramname"><em>comp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a component in the current cluster. HACK. This routine is a "friend" of icalfileset, and breaks its encapsulation. It was either do it this way, or add several layers of interfaces that had no other use. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Apr 9 2022 08:34:57 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>
|
