/usr/share/gtk-doc/html/libecal/libecal-e-cal-time-util.html is in libecal1.2-dev 3.2.3-0ubuntu6.
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 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 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 | <!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-time-util</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="prev" href="libecal-e-cal-recur.html" title="e-cal-recur">
<link rel="next" href="libecal-e-cal-types.html" title="e-cal-types">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libecal-e-cal-recur.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Calendar Client (libecal)</th>
<td><a accesskey="n" href="libecal-e-cal-types.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libecal-e-cal-time-util.synopsis" class="shortcut">Top</a>
|
<a href="#libecal-e-cal-time-util.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libecal-e-cal-time-util"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libecal-e-cal-time-util.top_of_page"></a>e-cal-time-util</span></h2>
<p>e-cal-time-util</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libecal-e-cal-time-util.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gint</span> <a class="link" href="libecal-e-cal-time-util.html#time-days-in-month" title="time_days_in_month ()">time_days_in_month</a> (<em class="parameter"><code><span class="type">gint</span> year</code></em>,
<em class="parameter"><code><span class="type">gint</span> month</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libecal-e-cal-time-util.html#time-day-of-year" title="time_day_of_year ()">time_day_of_year</a> (<em class="parameter"><code><span class="type">gint</span> day</code></em>,
<em class="parameter"><code><span class="type">gint</span> month</code></em>,
<em class="parameter"><code><span class="type">gint</span> year</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libecal-e-cal-time-util.html#time-day-of-week" title="time_day_of_week ()">time_day_of_week</a> (<em class="parameter"><code><span class="type">gint</span> day</code></em>,
<em class="parameter"><code><span class="type">gint</span> month</code></em>,
<em class="parameter"><code><span class="type">gint</span> year</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libecal-e-cal-time-util.html#time-is-leap-year" title="time_is_leap_year ()">time_is_leap_year</a> (<em class="parameter"><code><span class="type">gint</span> year</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libecal-e-cal-time-util.html#time-leap-years-up-to" title="time_leap_years_up_to ()">time_leap_years_up_to</a> (<em class="parameter"><code><span class="type">gint</span> year</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libecal-e-cal-time-util.html#isodate-from-time-t" title="isodate_from_time_t ()">isodate_from_time_t</a> (<em class="parameter"><code><span class="type">time_t</span> t</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-from-isodate" title="time_from_isodate ()">time_from_isodate</a> (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-add-day" title="time_add_day ()">time_add_day</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> days</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-add-week" title="time_add_week ()">time_add_week</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> weeks</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-day-begin" title="time_day_begin ()">time_day_begin</a> (<em class="parameter"><code><span class="type">time_t</span> t</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-day-end" title="time_day_end ()">time_day_end</a> (<em class="parameter"><code><span class="type">time_t</span> t</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-add-day-with-zone" title="time_add_day_with_zone ()">time_add_day_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> days</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-add-week-with-zone" title="time_add_week_with_zone ()">time_add_week_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> weeks</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-add-month-with-zone" title="time_add_month_with_zone ()">time_add_month_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> months</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-year-begin-with-zone" title="time_year_begin_with_zone ()">time_year_begin_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-month-begin-with-zone" title="time_month_begin_with_zone ()">time_month_begin_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-week-begin-with-zone" title="time_week_begin_with_zone ()">time_week_begin_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> week_start_day</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-day-begin-with-zone" title="time_day_begin_with_zone ()">time_day_begin_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">time_t</span> <a class="link" href="libecal-e-cal-time-util.html#time-day-end-with-zone" title="time_day_end_with_zone ()">time_day_end_with_zone</a> (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libecal-e-cal-time-util.html#time-to-gdate-with-zone" title="time_to_gdate_with_zone ()">time_to_gdate_with_zone</a> (<em class="parameter"><code><span class="type">GDate</span> *date</code></em>,
<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);
struct <span class="returnvalue">tm</span> <a class="link" href="libecal-e-cal-time-util.html#icaltimetype-to-tm" title="icaltimetype_to_tm ()">icaltimetype_to_tm</a> (<em class="parameter"><code><span class="type">struct icaltimetype</span> *itt</code></em>);
struct <span class="returnvalue">tm</span> <a class="link" href="libecal-e-cal-time-util.html#icaltimetype-to-tm-with-zone" title="icaltimetype_to_tm_with_zone ()">icaltimetype_to_tm_with_zone</a> (<em class="parameter"><code><span class="type">struct icaltimetype</span> *itt</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *from_zone</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *to_zone</code></em>);
struct <span class="returnvalue">icaltimetype</span> <a class="link" href="libecal-e-cal-time-util.html#tm-to-icaltimetype" title="tm_to_icaltimetype ()">tm_to_icaltimetype</a> (<em class="parameter"><code><span class="type">struct tm</span> *tm</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> is_date</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libecal-e-cal-time-util.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libecal-e-cal-time-util.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="time-days-in-month"></a><h3>time_days_in_month ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> time_days_in_month (<em class="parameter"><code><span class="type">gint</span> year</code></em>,
<em class="parameter"><code><span class="type">gint</span> month</code></em>);</pre>
<p>
Returns the number of days in the month. Year is the normal year, e.g. 2001.
Month is 0 (Jan) to 11 (Dec).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
<td>The year.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
<td>The month.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>number of days in the given month/year.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-day-of-year"></a><h3>time_day_of_year ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> time_day_of_year (<em class="parameter"><code><span class="type">gint</span> day</code></em>,
<em class="parameter"><code><span class="type">gint</span> month</code></em>,
<em class="parameter"><code><span class="type">gint</span> year</code></em>);</pre>
<p>
Returns the 1-based day number within the year of the specified date.
Year is the normal year, e.g. 2001. Month is 0 to 11.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
<td>The day.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
<td>The month.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
<td>The year.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the day of the year.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-day-of-week"></a><h3>time_day_of_week ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> time_day_of_week (<em class="parameter"><code><span class="type">gint</span> day</code></em>,
<em class="parameter"><code><span class="type">gint</span> month</code></em>,
<em class="parameter"><code><span class="type">gint</span> year</code></em>);</pre>
<p>
Returns the day of the week for the specified date, 0 (Sun) to 6 (Sat).
For the days that were removed on the Gregorian reformation, it returns
Thursday. Year is the normal year, e.g. 2001. Month is 0 to 11.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
<td>The day.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
<td>The month.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
<td>The year.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the day of the week for the given date.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-is-leap-year"></a><h3>time_is_leap_year ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> time_is_leap_year (<em class="parameter"><code><span class="type">gint</span> year</code></em>);</pre>
<p>
Returns whether the specified year is a leap year. Year is the normal year,
e.g. 2001.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
<td>The year.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the year is leap, FALSE if not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-leap-years-up-to"></a><h3>time_leap_years_up_to ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> time_leap_years_up_to (<em class="parameter"><code><span class="type">gint</span> year</code></em>);</pre>
<p>
Returns the number of leap years since year 1 up to (but not including) the
specified year. Year is the normal year, e.g. 2001.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
<td>The year.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>number of leap years.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="isodate-from-time-t"></a><h3>isodate_from_time_t ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * isodate_from_time_t (<em class="parameter"><code><span class="type">time_t</span> t</code></em>);</pre>
<p>
Creates an ISO 8601 UTC representation from a time value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
<td>A time value.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>String with the ISO 8601 representation of the UTC time.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-from-isodate"></a><h3>time_from_isodate ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_from_isodate (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
<p>
Converts an ISO 8601 UTC time string into a time_t value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>Date/time value in ISO 8601 format.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Time_t corresponding to the specified ISO string.
Note that we only allow UTC times at present.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-add-day"></a><h3>time_add_day ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_add_day (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> days</code></em>);</pre>
<p>
Adds a day onto the time, using local time.
Note that if clocks go forward due to daylight savings time, there are
some non-existent local times, so the hour may be changed to make it a
valid time. This also means that it may not be wise to keep calling
<a class="link" href="libecal-e-cal-time-util.html#time-add-day" title="time_add_day ()"><code class="function">time_add_day()</code></a> to step through a certain period - if the hour gets changed
to make it valid time, any further calls to <a class="link" href="libecal-e-cal-time-util.html#time-add-day" title="time_add_day ()"><code class="function">time_add_day()</code></a> will also return
this hour, which may not be what you want.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>days</code></em> :</span></p></td>
<td>Number of days to add.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a time_t value containing <em class="parameter"><code>time</code></em> plus the days added.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-add-week"></a><h3>time_add_week ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_add_week (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> weeks</code></em>);</pre>
<p>
Adds the given number of weeks to a time value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>weeks</code></em> :</span></p></td>
<td>Number of weeks to add.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a time_t value containing <em class="parameter"><code>time</code></em> plus the weeks added.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-day-begin"></a><h3>time_day_begin ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_day_begin (<em class="parameter"><code><span class="type">time_t</span> t</code></em>);</pre>
<p>
Returns the start of the day, according to the local time.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the time corresponding to the beginning of the day.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-day-end"></a><h3>time_day_end ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_day_end (<em class="parameter"><code><span class="type">time_t</span> t</code></em>);</pre>
<p>
Returns the end of the day, according to the local time.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the time corresponding to the end of the day.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-add-day-with-zone"></a><h3>time_add_day_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_add_day_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> days</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Adds or subtracts a number of days to/from the given time_t value, using
the given timezone.
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>days</code></em> :</span></p></td>
<td>Number of days to add.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a time_t value containing <em class="parameter"><code>time</code></em> plus the days added.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-add-week-with-zone"></a><h3>time_add_week_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_add_week_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> weeks</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Adds or subtracts a number of weeks to/from the given time_t value, using
the given timezone.
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>weeks</code></em> :</span></p></td>
<td>Number of weeks to add.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a time_t value containing <em class="parameter"><code>time</code></em> plus the weeks added.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-add-month-with-zone"></a><h3>time_add_month_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_add_month_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> months</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Adds or subtracts a number of months to/from the given time_t value, using
the given timezone.
</p>
<p>
If the day would be off the end of the month (e.g. adding 1 month to
30th January, would lead to an invalid day, 30th February), it moves it
down to the last day in the month, e.g. 28th Feb (or 29th in a leap year.)
</p>
<p>
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>months</code></em> :</span></p></td>
<td>Number of months to add.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a time_t value containing <em class="parameter"><code>time</code></em> plus the months added.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-year-begin-with-zone"></a><h3>time_year_begin_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_year_begin_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Returns the start of the year containing the given time_t, using the given
timezone.
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the beginning of the year.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-month-begin-with-zone"></a><h3>time_month_begin_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_month_begin_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Returns the start of the month containing the given time_t, using the given
timezone.
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the beginning of the month.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-week-begin-with-zone"></a><h3>time_week_begin_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_week_begin_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">gint</span> week_start_day</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Returns the start of the week containing the given time_t, using the given
timezone. week_start_day should use the same values as <code class="function">mktime()</code>,
i.e. 0 (Sun) to 6 (Sat).
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>week_start_day</code></em> :</span></p></td>
<td>Day to use as the starting of the week.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the beginning of the week.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-day-begin-with-zone"></a><h3>time_day_begin_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_day_begin_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Returns the start of the day containing the given time_t, using the given
timezone.
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the beginning of the day.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-day-end-with-zone"></a><h3>time_day_end_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span> time_day_end_with_zone (<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Returns the end of the day containing the given time_t, using the given
timezone. (The end of the day is the start of the next day.)
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<code class="function">icaltime_adjust()</code> to add or subtract days, hours, minutes & seconds.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time_t value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Timezone to use.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the end of the day.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="time-to-gdate-with-zone"></a><h3>time_to_gdate_with_zone ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> time_to_gdate_with_zone (<em class="parameter"><code><span class="type">GDate</span> *date</code></em>,
<em class="parameter"><code><span class="type">time_t</span> time</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>
Converts a time_t value to a <span class="type">GDate</span> structure using the specified timezone.
This is analogous to <code class="function">g_date_set_time()</code> but takes the timezone into account.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
<td>Destination <span class="type">GDate</span> value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
<td>A time value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>Desired timezone for destination <em class="parameter"><code>date</code></em>, or NULL if the UTC timezone
is desired.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="icaltimetype-to-tm"></a><h3>icaltimetype_to_tm ()</h3>
<pre class="programlisting">struct <span class="returnvalue">tm</span> icaltimetype_to_tm (<em class="parameter"><code><span class="type">struct icaltimetype</span> *itt</code></em>);</pre>
<p>
Convers an icaltimetype structure into a GLibc's struct tm.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>itt</code></em> :</span></p></td>
<td>An icaltimetype structure.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The converted time as a struct tm. All fields will be
set properly except for tm.tm_yday.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="icaltimetype-to-tm-with-zone"></a><h3>icaltimetype_to_tm_with_zone ()</h3>
<pre class="programlisting">struct <span class="returnvalue">tm</span> icaltimetype_to_tm_with_zone (<em class="parameter"><code><span class="type">struct icaltimetype</span> *itt</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *from_zone</code></em>,
<em class="parameter"><code><span class="type">icaltimezone</span> *to_zone</code></em>);</pre>
<p>
Converts a time value from one timezone to another, and returns a struct tm
representation of the time.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>itt</code></em> :</span></p></td>
<td>A time value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>from_zone</code></em> :</span></p></td>
<td>Source timezone.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>to_zone</code></em> :</span></p></td>
<td>Destination timezone.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The converted time as a struct tm. All fields will be
set properly except for tm.tm_yday.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="tm-to-icaltimetype"></a><h3>tm_to_icaltimetype ()</h3>
<pre class="programlisting">struct <span class="returnvalue">icaltimetype</span> tm_to_icaltimetype (<em class="parameter"><code><span class="type">struct tm</span> *tm</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> is_date</code></em>);</pre>
<p>
Converts a struct tm into an icaltimetype.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tm</code></em> :</span></p></td>
<td>A struct tm.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_date</code></em> :</span></p></td>
<td>Whether the given time is a date only or not.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The converted time as an icaltimetype.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|