/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-e-cal-check-timezones.html is in evolution-data-server-doc 3.28.1-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-cal-check-timezones: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch14.html" title="Calendar related utilities">
<link rel="prev" href="evolution-data-server-e-cal-system-timezone.html" title="e-cal-system-timezone">
<link rel="next" href="evolution-data-server-ETimezoneCache.html" title="ETimezoneCache">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#evolution-data-server-e-cal-check-timezones.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch14.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-e-cal-system-timezone.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="evolution-data-server-ETimezoneCache.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-data-server-e-cal-check-timezones"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-e-cal-check-timezones.top_of_page"></a>e-cal-check-timezones</span></h2>
<p>e-cal-check-timezones</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-e-cal-check-timezones.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-client-check-timezones" title="e_cal_client_check_timezones ()">e_cal_client_check_timezones</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-client-tzlookup" title="e_cal_client_tzlookup ()">e_cal_client_tzlookup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-client-tzlookup-icomp" title="e_cal_client_tzlookup_icomp ()">e_cal_client_tzlookup_icomp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-match-tzid" title="e_cal_match_tzid ()">e_cal_match_tzid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-check-timezones" title="e_cal_check_timezones ()">e_cal_check_timezones</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-tzlookup-ecal" title="e_cal_tzlookup_ecal ()">e_cal_tzlookup_ecal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-tzlookup-icomp" title="e_cal_tzlookup_icomp ()">e_cal_tzlookup_icomp</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-e-cal-check-timezones.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-data-server-e-cal-check-timezones.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-cal-client-check-timezones"></a><h3>e_cal_client_check_timezones ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_client_check_timezones (<em class="parameter"><code><span class="type">icalcomponent</span> *comp</code></em>,
<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *comps</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span>* (*tzlookup) (const gchar *tzid, gconstpointer ecalclient, GCancellable *cancellable, GError **error)</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> ecalclient</code></em>,
<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>This function cleans up VEVENT, VJOURNAL, VTODO and VTIMEZONE
items which are to be imported into Evolution.</p>
<p>Using VTIMEZONE definitions is problematic because they cannot be
updated properly when timezone definitions change. They are also
incomplete (for compatibility reason only one set of rules for
summer saving changes can be included, even if different rules
apply in different years). This function looks for matches of the
used TZIDs against system timezones and replaces such TZIDs with
the corresponding system timezone. This works for TZIDs containing
a location (found via a fuzzy string search) and for Outlook TZIDs
(via a hard-coded lookup table).</p>
<p>Some programs generate broken meeting invitations with TZID, but
without including the corresponding VTIMEZONE. Importing such
invitations unchanged causes problems later on (meeting displayed
incorrectly, <a class="link" href="evolution-data-server-ECal.html#e-cal-get-component-as-string" title="e_cal_get_component_as_string ()"><code class="function">e_cal_get_component_as_string()</code></a> fails). The situation
where this occurred in the past (found by a SyncEvolution user) is
now handled via the location based mapping.</p>
<p>If this mapping fails, this function also deals with VTIMEZONE
conflicts: such conflicts occur when the calendar already contains
an old VTIMEZONE definition with the same TZID, but different
summer saving rules. Replacing the VTIMEZONE potentially breaks
displaying of old events, whereas not replacing it breaks the new
events (the behavior in Evolution <= 2.22.1).</p>
<p>The way this problem is resolved is by renaming the new VTIMEZONE
definition until the TZID is unique. A running count is appended to
the TZID. All items referencing the renamed TZID are adapted
accordingly.</p>
<div class="refsect3">
<a name="e-cal-client-check-timezones.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>comp</p></td>
<td class="parameter_description"><p>a VCALENDAR containing a list of
VTIMEZONE and arbitrary other components, in
arbitrary order: these other components are
modified by this call</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>comps</p></td>
<td class="parameter_description"><p>a list of <span class="type">icalcomponent</span>
instances which also have to be patched; may be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> icalcomponent][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tzlookup</p></td>
<td class="parameter_description"><p>a callback function which is called to retrieve
a calendar's VTIMEZONE definition; the returned
definition is *not* freed by <a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-client-check-timezones" title="e_cal_client_check_timezones ()"><code class="function">e_cal_client_check_timezones()</code></a>
(to be compatible with <a class="link" href="evolution-data-server-ECal.html#e-cal-get-timezone" title="e_cal_get_timezone ()"><code class="function">e_cal_get_timezone()</code></a>);
NULL indicates that no such timezone exists
or an error occurred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ecalclient</p></td>
<td class="parameter_description"><p>an arbitrary pointer which is passed through to
the <em class="parameter"><code>tzlookup</code></em>
function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to use in <em class="parameter"><code>tzlookup</code></em>
function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>an error description in case of a failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-client-check-timezones.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-2.html#api-index-3.2">3.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-tzlookup"></a><h3>e_cal_client_tzlookup ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *
e_cal_client_tzlookup (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> ecalclient</code></em>,
<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>An implementation of the tzlookup callback which clients
can use. Calls <a class="link" href="evolution-data-server-ECalClient.html#e-cal-client-get-timezone-sync" title="e_cal_client_get_timezone_sync ()"><code class="function">e_cal_client_get_timezone_sync()</code></a>.</p>
<div class="refsect3">
<a name="e-cal-client-tzlookup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tzid</p></td>
<td class="parameter_description"><p>ID of the timezone to lookup</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ecalclient</p></td>
<td class="parameter_description"><p>must be a valid <a class="link" href="evolution-data-server-ECalClient.html#ECalClient" title="struct ECalClient"><span class="type">ECalClient</span></a> pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>an optional <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to use, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>an error description in case of a failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-client-tzlookup.returns"></a><h4>Returns</h4>
<p> A timezone object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. This object is owned
by the <em class="parameter"><code>ecalclient</code></em>
, thus do not free it.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-2.html#api-index-3.2">3.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-client-tzlookup-icomp"></a><h3>e_cal_client_tzlookup_icomp ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *
e_cal_client_tzlookup_icomp (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> custom</code></em>,
<em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>An implementation of the tzlookup callback which backends
like the file backend can use. Searches for the timezone
in the component list.</p>
<div class="refsect3">
<a name="e-cal-client-tzlookup-icomp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tzid</p></td>
<td class="parameter_description"><p>ID of the timezone to lookup</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>custom</p></td>
<td class="parameter_description"><p>must be a icalcomponent pointer which contains
either a VCALENDAR with VTIMEZONEs or VTIMEZONES
directly</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>an optional <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> to use, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>an error description in case of a failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-client-tzlookup-icomp.returns"></a><h4>Returns</h4>
<p> A timezone object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found inside <em class="parameter"><code>custom</code></em>
. This object is owned
by the <em class="parameter"><code>custom</code></em>
, thus do not free it.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-2.html#api-index-3.2">3.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-match-tzid"></a><h3>e_cal_match_tzid ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_cal_match_tzid (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>);</pre>
<p>Matches <em class="parameter"><code>tzid</code></em>
against the system timezone definitions
and returns the matching TZID, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none found</p>
<div class="refsect3">
<a name="e-cal-match-tzid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>tzid</p></td>
<td class="parameter_description"><p>a timezone ID</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-24.html#api-index-2.24">2.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-check-timezones"></a><h3>e_cal_check_timezones ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cal_check_timezones (<em class="parameter"><code><span class="type">icalcomponent</span> *comp</code></em>,
<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *comps</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span>* (*tzlookup) (const gchar *tzid, gconstpointer custom, GError **error)</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> custom</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cal_check_timezones</code> has been deprecated since version 3.2 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-client-check-timezones" title="e_cal_client_check_timezones ()"><code class="function">e_cal_client_check_timezones()</code></a> instead.</p>
</div>
<p>This function cleans up VEVENT, VJOURNAL, VTODO and VTIMEZONE
items which are to be imported into Evolution.</p>
<p>Using VTIMEZONE definitions is problematic because they cannot be
updated properly when timezone definitions change. They are also
incomplete (for compatibility reason only one set of rules for
summer saving changes can be included, even if different rules
apply in different years). This function looks for matches of the
used TZIDs against system timezones and replaces such TZIDs with
the corresponding system timezone. This works for TZIDs containing
a location (found via a fuzzy string search) and for Outlook TZIDs
(via a hard-coded lookup table).</p>
<p>Some programs generate broken meeting invitations with TZID, but
without including the corresponding VTIMEZONE. Importing such
invitations unchanged causes problems later on (meeting displayed
incorrectly, <a class="link" href="evolution-data-server-ECal.html#e-cal-get-component-as-string" title="e_cal_get_component_as_string ()"><code class="function">e_cal_get_component_as_string()</code></a> fails). The situation
where this occurred in the past (found by a SyncEvolution user) is
now handled via the location based mapping.</p>
<p>If this mapping fails, this function also deals with VTIMEZONE
conflicts: such conflicts occur when the calendar already contains
an old VTIMEZONE definition with the same TZID, but different
summer saving rules. Replacing the VTIMEZONE potentially breaks
displaying of old events, whereas not replacing it breaks the new
events (the behavior in Evolution <= 2.22.1).</p>
<p>The way this problem is resolved is by renaming the new VTIMEZONE
definition until the TZID is unique. A running count is appended to
the TZID. All items referencing the renamed TZID are adapted
accordingly.</p>
<div class="refsect3">
<a name="e-cal-check-timezones.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>comp</p></td>
<td class="parameter_description"><p>a VCALENDAR containing a list of
VTIMEZONE and arbitrary other components, in
arbitrary order: these other components are
modified by this call</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>comps</p></td>
<td class="parameter_description"><p>a list of <span class="type">icalcomponent</span>
instances which also have to be patched; may be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> icalcomponent][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tzlookup</p></td>
<td class="parameter_description"><p>a callback function which is called to retrieve
a calendar's VTIMEZONE definition; the returned
definition is *not* freed by <a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-check-timezones" title="e_cal_check_timezones ()"><code class="function">e_cal_check_timezones()</code></a>
(to be compatible with <a class="link" href="evolution-data-server-ECal.html#e-cal-get-timezone" title="e_cal_get_timezone ()"><code class="function">e_cal_get_timezone()</code></a>);
<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> indicates that no such timezone exists
or an error occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>custom</p></td>
<td class="parameter_description"><p>an arbitrary pointer which is passed through to
the tzlookup function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>an error description in case of a failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-check-timezones.returns"></a><h4>Returns</h4>
<p> TRUE if successful, FALSE otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-24.html#api-index-2.24">2.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-tzlookup-ecal"></a><h3>e_cal_tzlookup_ecal ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *
e_cal_tzlookup_ecal (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> custom</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cal_tzlookup_ecal</code> has been deprecated since version 3.2 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-client-tzlookup" title="e_cal_client_tzlookup ()"><code class="function">e_cal_client_tzlookup()</code></a> instead.</p>
</div>
<p>An implementation of the tzlookup callback which clients
can use. Calls <a class="link" href="evolution-data-server-ECal.html#e-cal-get-timezone" title="e_cal_get_timezone ()"><code class="function">e_cal_get_timezone()</code></a>.</p>
<div class="refsect3">
<a name="e-cal-tzlookup-ecal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tzid</p></td>
<td class="parameter_description"><p>ID of the timezone to lookup</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>custom</p></td>
<td class="parameter_description"><p>must be a valid <a class="link" href="evolution-data-server-ECal.html#ECal" title="struct ECal"><span class="type">ECal</span></a> pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>an error description in case of a failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-tzlookup-ecal.returns"></a><h4>Returns</h4>
<p> A timezone object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. This object is owned
by the <em class="parameter"><code>custom</code></em>
, thus do not free it.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-24.html#api-index-2.24">2.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cal-tzlookup-icomp"></a><h3>e_cal_tzlookup_icomp ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *
e_cal_tzlookup_icomp (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> custom</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cal_tzlookup_icomp</code> has been deprecated since version 3.2 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="evolution-data-server-e-cal-check-timezones.html#e-cal-client-tzlookup-icomp" title="e_cal_client_tzlookup_icomp ()"><code class="function">e_cal_client_tzlookup_icomp()</code></a> instead.</p>
</div>
<p>An implementation of the tzlookup callback which backends
like the file backend can use. Searches for the timezone
in the component list.</p>
<div class="refsect3">
<a name="e-cal-tzlookup-icomp.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tzid</p></td>
<td class="parameter_description"><p>ID of the timezone to lookup</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>custom</p></td>
<td class="parameter_description"><p>must be a icalcomponent pointer which contains
either a VCALENDAR with VTIMEZONEs or VTIMEZONES
directly</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>an error description in case of a failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cal-tzlookup-icomp.returns"></a><h4>Returns</h4>
<p> A timezone object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found inside <em class="parameter"><code>custom</code></em>
. This object is owned
by the <em class="parameter"><code>custom</code></em>
, thus do not free it.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-24.html#api-index-2.24">2.24</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-e-cal-check-timezones.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|