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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
|
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icaltimezone.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 id="projectrow">
<td id="projectalign">
<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.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">icaltimezone.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Timezone handling routines.
<a href="#details">More...</a></p>
<p><a href="icaltimezone_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 id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a8561e9d4374ca1e29cd5ade459a50208"><td class="memItemLeft" align="right" valign="top"><a id="a8561e9d4374ca1e29cd5ade459a50208" name="a8561e9d4374ca1e29cd5ade459a50208"></a>
typedef struct <a class="el" href="struct__icaltimezone.html">_icaltimezone</a> </td><td class="memItemRight" valign="bottom"><b>icaltimezone</b></td></tr>
<tr class="memdesc:a8561e9d4374ca1e29cd5ade459a50208"><td class="mdescLeft"> </td><td class="mdescRight">An opaque struct representing a timezone. We declare this here to avoid a circular dependency. <br /></td></tr>
<tr class="separator:a8561e9d4374ca1e29cd5ade459a50208"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a431f7b425ec073cdd490431d4285f294"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a431f7b425ec073cdd490431d4285f294">free_zone_directory</a> (void)</td></tr>
<tr class="separator:a431f7b425ec073cdd490431d4285f294"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe6dd6b2d7421e20b26b448e05947bc8"><td class="memItemLeft" align="right" valign="top"><a id="abe6dd6b2d7421e20b26b448e05947bc8" name="abe6dd6b2d7421e20b26b448e05947bc8"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_array_append_from_vtimezone</b> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *timezones, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *child)</td></tr>
<tr class="separator:abe6dd6b2d7421e20b26b448e05947bc8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05bf1ca4e3c3a13af28331a7f0ddbe7e"><td class="memItemLeft" align="right" valign="top"><a id="a05bf1ca4e3c3a13af28331a7f0ddbe7e" name="a05bf1ca4e3c3a13af28331a7f0ddbe7e"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_array_free</b> (<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *timezones)</td></tr>
<tr class="separator:a05bf1ca4e3c3a13af28331a7f0ddbe7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae896f8e01ef31170224fea9cc7592b66"><td class="memItemLeft" align="right" valign="top"><a id="ae896f8e01ef31170224fea9cc7592b66" name="ae896f8e01ef31170224fea9cc7592b66"></a>
<a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_array_new</b> (void)</td></tr>
<tr class="separator:ae896f8e01ef31170224fea9cc7592b66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2d1ee1c58825d3308713fc71387fda8"><td class="memItemLeft" align="right" valign="top"><a id="ad2d1ee1c58825d3308713fc71387fda8" name="ad2d1ee1c58825d3308713fc71387fda8"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_convert_time</b> (struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *tt, <a class="el" href="struct__icaltimezone.html">icaltimezone</a> *from_zone, <a class="el" href="struct__icaltimezone.html">icaltimezone</a> *to_zone)</td></tr>
<tr class="separator:ad2d1ee1c58825d3308713fc71387fda8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31b954b31962b4325d3827bbe3de9e10"><td class="memItemLeft" align="right" valign="top"><a id="a31b954b31962b4325d3827bbe3de9e10" name="a31b954b31962b4325d3827bbe3de9e10"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_copy</b> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *originalzone)</td></tr>
<tr class="separator:a31b954b31962b4325d3827bbe3de9e10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12c7192c39744d49e4c23249926ae22a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a12c7192c39744d49e4c23249926ae22a">icaltimezone_dump_changes</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, int max_year, FILE *fp)</td></tr>
<tr class="memdesc:a12c7192c39744d49e4c23249926ae22a"><td class="mdescLeft"> </td><td class="mdescRight">Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given. <a href="icaltimezone_8h.html#a12c7192c39744d49e4c23249926ae22a">More...</a><br /></td></tr>
<tr class="separator:a12c7192c39744d49e4c23249926ae22a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56289e228ebd731806c73eb6dfcf57b0"><td class="memItemLeft" align="right" valign="top"><a id="a56289e228ebd731806c73eb6dfcf57b0" name="a56289e228ebd731806c73eb6dfcf57b0"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_expand_vtimezone</b> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp, int end_year, <a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *changes)</td></tr>
<tr class="separator:a56289e228ebd731806c73eb6dfcf57b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa96c3397fd8bcce74e1f220ca3fc333d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#aa96c3397fd8bcce74e1f220ca3fc333d">icaltimezone_free</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, int free_struct)</td></tr>
<tr class="memdesc:aa96c3397fd8bcce74e1f220ca3fc333d"><td class="mdescLeft"> </td><td class="mdescRight">Frees all memory used for the icaltimezone. <a href="icaltimezone_8h.html#aa96c3397fd8bcce74e1f220ca3fc333d">More...</a><br /></td></tr>
<tr class="separator:aa96c3397fd8bcce74e1f220ca3fc333d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7596677c1f0c38bac7e687f37e19e397"><td class="memItemLeft" align="right" valign="top"><a id="a7596677c1f0c38bac7e687f37e19e397" name="a7596677c1f0c38bac7e687f37e19e397"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_free_builtin_timezones</b> (void)</td></tr>
<tr class="memdesc:a7596677c1f0c38bac7e687f37e19e397"><td class="mdescLeft"> </td><td class="mdescRight">Releases builtin timezone memory. <br /></td></tr>
<tr class="separator:a7596677c1f0c38bac7e687f37e19e397"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8670c0a0730ddb27a2a59efb9b476b24"><td class="memItemLeft" align="right" valign="top"><a id="a8670c0a0730ddb27a2a59efb9b476b24" name="a8670c0a0730ddb27a2a59efb9b476b24"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_builtin_timezone</b> (const char *location)</td></tr>
<tr class="memdesc:a8670c0a0730ddb27a2a59efb9b476b24"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single builtin timezone, given its Olson city name. <br /></td></tr>
<tr class="separator:a8670c0a0730ddb27a2a59efb9b476b24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1224ff59d8d1618ee41f17b5c6357312"><td class="memItemLeft" align="right" valign="top"><a id="a1224ff59d8d1618ee41f17b5c6357312" name="a1224ff59d8d1618ee41f17b5c6357312"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_builtin_timezone_from_offset</b> (int offset, const char *tzname)</td></tr>
<tr class="memdesc:a1224ff59d8d1618ee41f17b5c6357312"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single builtin timezone, given its offset from UTC. <br /></td></tr>
<tr class="separator:a1224ff59d8d1618ee41f17b5c6357312"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad05c4a96c4e7095f574641dfb9ceafc5"><td class="memItemLeft" align="right" valign="top"><a id="ad05c4a96c4e7095f574641dfb9ceafc5" name="ad05c4a96c4e7095f574641dfb9ceafc5"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_builtin_timezone_from_tzid</b> (const char *tzid)</td></tr>
<tr class="memdesc:ad05c4a96c4e7095f574641dfb9ceafc5"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single builtin timezone, given its TZID. <br /></td></tr>
<tr class="separator:ad05c4a96c4e7095f574641dfb9ceafc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b765c5eb599505d208c89a799e13d21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a8b765c5eb599505d208c89a799e13d21">icaltimezone_get_builtin_timezones</a> (void)</td></tr>
<tr class="memdesc:a8b765c5eb599505d208c89a799e13d21"><td class="mdescLeft"> </td><td class="mdescRight">Returns an icalarray of icaltimezone structs, one for each builtin timezone. <a href="icaltimezone_8h.html#a8b765c5eb599505d208c89a799e13d21">More...</a><br /></td></tr>
<tr class="separator:a8b765c5eb599505d208c89a799e13d21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac61539c2df5b4f58a453ac3377d5ad6b"><td class="memItemLeft" align="right" valign="top"><a id="ac61539c2df5b4f58a453ac3377d5ad6b" name="ac61539c2df5b4f58a453ac3377d5ad6b"></a>
int </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_builtin_tzdata</b> (void)</td></tr>
<tr class="separator:ac61539c2df5b4f58a453ac3377d5ad6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a684813584e0e55460be636e8ebc81f53"><td class="memItemLeft" align="right" valign="top"><a id="a684813584e0e55460be636e8ebc81f53" name="a684813584e0e55460be636e8ebc81f53"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_component</b> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr>
<tr class="memdesc:a684813584e0e55460be636e8ebc81f53"><td class="mdescLeft"> </td><td class="mdescRight">Returns the VTIMEZONE component of a timezone. <br /></td></tr>
<tr class="separator:a684813584e0e55460be636e8ebc81f53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf3d9c36dca3dd4e2233aac2a88997bc"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#aaf3d9c36dca3dd4e2233aac2a88997bc">icaltimezone_get_display_name</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr>
<tr class="memdesc:aaf3d9c36dca3dd4e2233aac2a88997bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timezone name to display to the user. <a href="icaltimezone_8h.html#aaf3d9c36dca3dd4e2233aac2a88997bc">More...</a><br /></td></tr>
<tr class="separator:aaf3d9c36dca3dd4e2233aac2a88997bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfc51cb64dcc62ff668df02073c803d6"><td class="memItemLeft" align="right" valign="top"><a id="acfc51cb64dcc62ff668df02073c803d6" name="acfc51cb64dcc62ff668df02073c803d6"></a>
double </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_latitude</b> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr>
<tr class="memdesc:acfc51cb64dcc62ff668df02073c803d6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the latitude of a builtin timezone. <br /></td></tr>
<tr class="separator:acfc51cb64dcc62ff668df02073c803d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a876e1b3dc89bc76961708fe6974a03c1"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a876e1b3dc89bc76961708fe6974a03c1">icaltimezone_get_location</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr>
<tr class="separator:a876e1b3dc89bc76961708fe6974a03c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4666bfd001ff5654fc3ee851e2e2338e"><td class="memItemLeft" align="right" valign="top"><a id="a4666bfd001ff5654fc3ee851e2e2338e" name="a4666bfd001ff5654fc3ee851e2e2338e"></a>
char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_location_from_vtimezone</b> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *component)</td></tr>
<tr class="memdesc:a4666bfd001ff5654fc3ee851e2e2338e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE. <br /></td></tr>
<tr class="separator:a4666bfd001ff5654fc3ee851e2e2338e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a346caee2838d8dfbeb07bc9c66b04e2b"><td class="memItemLeft" align="right" valign="top"><a id="a346caee2838d8dfbeb07bc9c66b04e2b" name="a346caee2838d8dfbeb07bc9c66b04e2b"></a>
double </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_longitude</b> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr>
<tr class="memdesc:a346caee2838d8dfbeb07bc9c66b04e2b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the longitude of a builtin timezone. <br /></td></tr>
<tr class="separator:a346caee2838d8dfbeb07bc9c66b04e2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d74150570a8a31e1fb8fe976fea9250"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a8d74150570a8a31e1fb8fe976fea9250">icaltimezone_get_tzid</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr>
<tr class="separator:a8d74150570a8a31e1fb8fe976fea9250"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7de03feecf3cbb0c7899b36d1285fd63"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a7de03feecf3cbb0c7899b36d1285fd63">icaltimezone_get_tznames</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr>
<tr class="separator:a7de03feecf3cbb0c7899b36d1285fd63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48a804fe8f8d61aed3efbf86504baf79"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a48a804fe8f8d61aed3efbf86504baf79">icaltimezone_get_tznames_from_vtimezone</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *component)</td></tr>
<tr class="memdesc:a48a804fe8f8d61aed3efbf86504baf79"><td class="mdescLeft"> </td><td class="mdescRight">Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE. <a href="icaltimezone_8h.html#a48a804fe8f8d61aed3efbf86504baf79">More...</a><br /></td></tr>
<tr class="separator:a48a804fe8f8d61aed3efbf86504baf79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ebe99e4975a461da82f4add92ca01d4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a1ebe99e4975a461da82f4add92ca01d4">icaltimezone_get_utc_offset</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *tt, int *is_daylight)</td></tr>
<tr class="memdesc:a1ebe99e4975a461da82f4add92ca01d4"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the UTC offset of a given local time in the given timezone. <a href="icaltimezone_8h.html#a1ebe99e4975a461da82f4add92ca01d4">More...</a><br /></td></tr>
<tr class="separator:a1ebe99e4975a461da82f4add92ca01d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6c4b7dc1e0c056bfbbd0f833d039b5d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#af6c4b7dc1e0c056bfbbd0f833d039b5d">icaltimezone_get_utc_offset_of_utc_time</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *tt, int *is_daylight)</td></tr>
<tr class="memdesc:af6c4b7dc1e0c056bfbbd0f833d039b5d"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the UTC offset of a given UTC time in the given timezone. <a href="icaltimezone_8h.html#af6c4b7dc1e0c056bfbbd0f833d039b5d">More...</a><br /></td></tr>
<tr class="separator:af6c4b7dc1e0c056bfbbd0f833d039b5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e9c520fc9a3ec85f5cc63fef1548583"><td class="memItemLeft" align="right" valign="top"><a id="a8e9c520fc9a3ec85f5cc63fef1548583" name="a8e9c520fc9a3ec85f5cc63fef1548583"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_utc_timezone</b> (void)</td></tr>
<tr class="memdesc:a8e9c520fc9a3ec85f5cc63fef1548583"><td class="mdescLeft"> </td><td class="mdescRight">Returns the UTC timezone. <br /></td></tr>
<tr class="separator:a8e9c520fc9a3ec85f5cc63fef1548583"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01b653e3e1f9feefc63e7d71c036f330"><td class="memItemLeft" align="right" valign="top"><a id="a01b653e3e1f9feefc63e7d71c036f330" name="a01b653e3e1f9feefc63e7d71c036f330"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_new</b> (void)</td></tr>
<tr class="memdesc:a01b653e3e1f9feefc63e7d71c036f330"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new icaltimezone. <br /></td></tr>
<tr class="separator:a01b653e3e1f9feefc63e7d71c036f330"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab04e61bc742f6fb07472b682d838822c"><td class="memItemLeft" align="right" valign="top"><a id="ab04e61bc742f6fb07472b682d838822c" name="ab04e61bc742f6fb07472b682d838822c"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_release_zone_tab</b> (void)</td></tr>
<tr class="separator:ab04e61bc742f6fb07472b682d838822c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74df462127727a146144d1eb80067c72"><td class="memItemLeft" align="right" valign="top"><a id="a74df462127727a146144d1eb80067c72" name="a74df462127727a146144d1eb80067c72"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_set_builtin_tzdata</b> (int set)</td></tr>
<tr class="separator:a74df462127727a146144d1eb80067c72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac06a9a060f021b7f4bdff282b2638357"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ac06a9a060f021b7f4bdff282b2638357">icaltimezone_set_component</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr>
<tr class="memdesc:ac06a9a060f021b7f4bdff282b2638357"><td class="mdescLeft"> </td><td class="mdescRight">Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location & tzname fields. <a href="icaltimezone_8h.html#ac06a9a060f021b7f4bdff282b2638357">More...</a><br /></td></tr>
<tr class="separator:ac06a9a060f021b7f4bdff282b2638357"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04849ce67c1a529f19d695b74cb238fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a04849ce67c1a529f19d695b74cb238fe">icaltimezone_set_tzid_prefix</a> (const char *new_prefix)</td></tr>
<tr class="separator:a04849ce67c1a529f19d695b74cb238fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3f7b3e1e9e500c4a7c2deb194507204"><td class="memItemLeft" align="right" valign="top"><a id="af3f7b3e1e9e500c4a7c2deb194507204" name="af3f7b3e1e9e500c4a7c2deb194507204"></a>
void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_truncate_vtimezone</b> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *vtz, <a class="el" href="structicaltimetype.html">icaltimetype</a> start, <a class="el" href="structicaltimetype.html">icaltimetype</a> end, int ms_compatible)</td></tr>
<tr class="separator:af3f7b3e1e9e500c4a7c2deb194507204"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8d207d1083c025f61a4ade54113f43e"><td class="memItemLeft" align="right" valign="top"><a id="af8d207d1083c025f61a4ade54113f43e" name="af8d207d1083c025f61a4ade54113f43e"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_tzid_prefix</b> (void)</td></tr>
<tr class="separator:af8d207d1083c025f61a4ade54113f43e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af35f72898e3992529e12c07c62659b22"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#af35f72898e3992529e12c07c62659b22">set_zone_directory</a> (const char *path)</td></tr>
<tr class="separator:af35f72898e3992529e12c07c62659b22"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Timezone handling routines. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a431f7b425ec073cdd490431d4285f294" name="a431f7b425ec073cdd490431d4285f294"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a431f7b425ec073cdd490431d4285f294">◆ </a></span>free_zone_directory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void free_zone_directory </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Frees the memory dedicated to the zonefile directory </p>
</div>
</div>
<a id="a12c7192c39744d49e4c23249926ae22a" name="a12c7192c39744d49e4c23249926ae22a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12c7192c39744d49e4c23249926ae22a">◆ </a></span>icaltimezone_dump_changes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int icaltimezone_dump_changes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_year</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given. </p>
<p >We compare this output with the output from 'vzic –dump-changes' to make sure that we are consistent. (vzic is the Olson timezone database to VTIMEZONE converter.)</p>
<p >The output format is: </p><pre class="fragment"> Zone-Name [tab] Date [tab] Time [tab] UTC-Offset
</pre><p> The Date and Time fields specify the time change in UTC.</p>
<p >The UTC Offset is for local (wall-clock) time. It is the amount of time to add to UTC to get local time. </p>
</div>
</div>
<a id="aa96c3397fd8bcce74e1f220ca3fc333d" name="aa96c3397fd8bcce74e1f220ca3fc333d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa96c3397fd8bcce74e1f220ca3fc333d">◆ </a></span>icaltimezone_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icaltimezone_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>free_struct</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees all memory used for the icaltimezone. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">zone</td><td>The icaltimezone to be freed </td></tr>
<tr><td class="paramname">free_struct</td><td>Whether to free the icaltimezone struct as well </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8b765c5eb599505d208c89a799e13d21" name="a8b765c5eb599505d208c89a799e13d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b765c5eb599505d208c89a799e13d21">◆ </a></span>icaltimezone_get_builtin_timezones()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * icaltimezone_get_builtin_timezones </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an icalarray of icaltimezone structs, one for each builtin timezone. </p>
<p >This will load and parse the zones.tab file to get the timezone names and their coordinates. It will not load the VTIMEZONE data for any timezones. </p>
</div>
</div>
<a id="aaf3d9c36dca3dd4e2233aac2a88997bc" name="aaf3d9c36dca3dd4e2233aac2a88997bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf3d9c36dca3dd4e2233aac2a88997bc">◆ </a></span>icaltimezone_get_display_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * icaltimezone_get_display_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the timezone name to display to the user. </p>
<p >We prefer to use the Olson city name, but fall back on the TZNAME, or finally the TZID. We don't want to use "" as it may be wrongly interpreted as a floating time. Do not free the returned string. </p>
</div>
</div>
<a id="a876e1b3dc89bc76961708fe6974a03c1" name="a876e1b3dc89bc76961708fe6974a03c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a876e1b3dc89bc76961708fe6974a03c1">◆ </a></span>icaltimezone_get_location()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * icaltimezone_get_location </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns the city name of a timezone. </p>
</div>
</div>
<a id="a8d74150570a8a31e1fb8fe976fea9250" name="a8d74150570a8a31e1fb8fe976fea9250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d74150570a8a31e1fb8fe976fea9250">◆ </a></span>icaltimezone_get_tzid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * icaltimezone_get_tzid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns the TZID of a timezone. </p>
</div>
</div>
<a id="a7de03feecf3cbb0c7899b36d1285fd63" name="a7de03feecf3cbb0c7899b36d1285fd63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7de03feecf3cbb0c7899b36d1285fd63">◆ </a></span>icaltimezone_get_tznames()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * icaltimezone_get_tznames </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns the TZNAME properties used in the latest STANDARD and DAYLIGHT components. If they are the same it will return just one, e.g. "LMT". If they are different it will format them like "EST/EDT". Note that this may also return NULL. </p>
</div>
</div>
<a id="a48a804fe8f8d61aed3efbf86504baf79" name="a48a804fe8f8d61aed3efbf86504baf79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48a804fe8f8d61aed3efbf86504baf79">◆ </a></span>icaltimezone_get_tznames_from_vtimezone()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * icaltimezone_get_tznames_from_vtimezone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td>
<td class="paramname"><em>component</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE. </p>
<p >If both STANDARD and DAYLIGHT components use the same TZNAME, it returns that. If they use different TZNAMEs, it formats them like "EST/EDT". The returned string should be freed by the caller. </p>
</div>
</div>
<a id="a1ebe99e4975a461da82f4add92ca01d4" name="a1ebe99e4975a461da82f4add92ca01d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ebe99e4975a461da82f4add92ca01d4">◆ </a></span>icaltimezone_get_utc_offset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int icaltimezone_get_utc_offset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> * </td>
<td class="paramname"><em>tt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>is_daylight</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the UTC offset of a given local time in the given timezone. </p>
<p >It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time. </p>
</div>
</div>
<a id="af6c4b7dc1e0c056bfbbd0f833d039b5d" name="af6c4b7dc1e0c056bfbbd0f833d039b5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6c4b7dc1e0c056bfbbd0f833d039b5d">◆ </a></span>icaltimezone_get_utc_offset_of_utc_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int icaltimezone_get_utc_offset_of_utc_time </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> * </td>
<td class="paramname"><em>tt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>is_daylight</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the UTC offset of a given UTC time in the given timezone. </p>
<p >It is the number of seconds to add to UTC to get local time. The <code>is_daylight</code> flag is set to 1 if the time is in daylight-savings time. </p>
</div>
</div>
<a id="ac06a9a060f021b7f4bdff282b2638357" name="ac06a9a060f021b7f4bdff282b2638357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac06a9a060f021b7f4bdff282b2638357">◆ </a></span>icaltimezone_set_component()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int icaltimezone_set_component </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td>
<td class="paramname"><em>zone</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>Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location & tzname fields. </p>
<dl class="section return"><dt>Returns</dt><dd>1 on success or 0 on failure, i.e. no TZID was found. </dd></dl>
</div>
</div>
<a id="a04849ce67c1a529f19d695b74cb238fe" name="a04849ce67c1a529f19d695b74cb238fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04849ce67c1a529f19d695b74cb238fe">◆ </a></span>icaltimezone_set_tzid_prefix()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icaltimezone_set_tzid_prefix </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>new_prefix</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Sets the prefix to be used for tzid's generated from system tzdata. Must be globally unique (such as a domain name owned by the developer of the calling application), and begin and end with forward slashes. Do not change or de-allocate the string buffer after calling this. </p>
</div>
</div>
<a id="af35f72898e3992529e12c07c62659b22" name="af35f72898e3992529e12c07c62659b22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af35f72898e3992529e12c07c62659b22">◆ </a></span>set_zone_directory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void set_zone_directory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Sets the directory to look for the zonefiles </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 10 2022 08:27:16 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.3
</small></address>
</body>
</html>
|
