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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libecal-e-cal-time-util">
<refmeta>
<refentrytitle role="top_of_page">e-cal-time-util</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBECAL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>e-cal-time-util</refname>
<refpurpose>Time management utility functions.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="int">int</link> <link linkend="time-days-in-month">time_days_in_month</link> (<link linkend="int">int</link> year,
<link linkend="int">int</link> month);
<link linkend="int">int</link> <link linkend="time-day-of-year">time_day_of_year</link> (<link linkend="int">int</link> day,
<link linkend="int">int</link> month,
<link linkend="int">int</link> year);
<link linkend="int">int</link> <link linkend="time-day-of-week">time_day_of_week</link> (<link linkend="int">int</link> day,
<link linkend="int">int</link> month,
<link linkend="int">int</link> year);
<link linkend="gboolean">gboolean</link> <link linkend="time-is-leap-year">time_is_leap_year</link> (<link linkend="int">int</link> year);
<link linkend="int">int</link> <link linkend="time-leap-years-up-to">time_leap_years_up_to</link> (<link linkend="int">int</link> year);
<link linkend="char">char</link>* <link linkend="isodate-from-time-t">isodate_from_time_t</link> (<link linkend="time-t">time_t</link> t);
<link linkend="time-t">time_t</link> <link linkend="time-from-isodate">time_from_isodate</link> (const <link linkend="char">char</link> *str);
<link linkend="time-t">time_t</link> <link linkend="time-add-day">time_add_day</link> (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> days);
<link linkend="time-t">time_t</link> <link linkend="time-add-week">time_add_week</link> (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> weeks);
<link linkend="time-t">time_t</link> <link linkend="time-day-begin">time_day_begin</link> (<link linkend="time-t">time_t</link> t);
<link linkend="time-t">time_t</link> <link linkend="time-day-end">time_day_end</link> (<link linkend="time-t">time_t</link> t);
<link linkend="time-t">time_t</link> <link linkend="time-add-day-with-zone">time_add_day_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> days,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="time-t">time_t</link> <link linkend="time-add-week-with-zone">time_add_week_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> weeks,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="time-t">time_t</link> <link linkend="time-add-month-with-zone">time_add_month_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> months,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="time-t">time_t</link> <link linkend="time-year-begin-with-zone">time_year_begin_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="time-t">time_t</link> <link linkend="time-month-begin-with-zone">time_month_begin_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="time-t">time_t</link> <link linkend="time-week-begin-with-zone">time_week_begin_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> week_start_day,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="time-t">time_t</link> <link linkend="time-day-begin-with-zone">time_day_begin_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="time-t">time_t</link> <link linkend="time-day-end-with-zone">time_day_end_with_zone</link> (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);
<link linkend="void">void</link> <link linkend="time-to-gdate-with-zone">time_to_gdate_with_zone</link> (<link linkend="GDate">GDate</link> *date,
<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="time-days-in-month" role="function"/>time_days_in_month ()</title>
<indexterm><primary>time_days_in_month</primary></indexterm><programlisting><link linkend="int">int</link> time_days_in_month (<link linkend="int">int</link> year,
<link linkend="int">int</link> month);</programlisting>
<para>
Returns the number of days in the month. Year is the normal year, e.g. 2001.
Month is 0 (Jan) to 11 (Dec).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> The year.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> The month.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> number of days in the given month/year.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-day-of-year" role="function"/>time_day_of_year ()</title>
<indexterm><primary>time_day_of_year</primary></indexterm><programlisting><link linkend="int">int</link> time_day_of_year (<link linkend="int">int</link> day,
<link linkend="int">int</link> month,
<link linkend="int">int</link> year);</programlisting>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> The day.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> The month.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> The year.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the day of the year.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-day-of-week" role="function"/>time_day_of_week ()</title>
<indexterm><primary>time_day_of_week</primary></indexterm><programlisting><link linkend="int">int</link> time_day_of_week (<link linkend="int">int</link> day,
<link linkend="int">int</link> month,
<link linkend="int">int</link> year);</programlisting>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> The day.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> The month.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> The year.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the day of the week for the given date.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-is-leap-year" role="function"/>time_is_leap_year ()</title>
<indexterm><primary>time_is_leap_year</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> time_is_leap_year (<link linkend="int">int</link> year);</programlisting>
<para>
Returns whether the specified year is a leap year. Year is the normal year,
e.g. 2001.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> The year.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the year is leap, FALSE if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-leap-years-up-to" role="function"/>time_leap_years_up_to ()</title>
<indexterm><primary>time_leap_years_up_to</primary></indexterm><programlisting><link linkend="int">int</link> time_leap_years_up_to (<link linkend="int">int</link> year);</programlisting>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> The year.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> number of leap years.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="isodate-from-time-t" role="function"/>isodate_from_time_t ()</title>
<indexterm><primary>isodate_from_time_t</primary></indexterm><programlisting><link linkend="char">char</link>* isodate_from_time_t (<link linkend="time-t">time_t</link> t);</programlisting>
<para>
Creates an ISO 8601 UTC representation from a time value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>t</parameter> :</term>
<listitem><simpara> A time value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> String with the ISO 8601 representation of the UTC time.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-from-isodate" role="function"/>time_from_isodate ()</title>
<indexterm><primary>time_from_isodate</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_from_isodate (const <link linkend="char">char</link> *str);</programlisting>
<para>
Converts an ISO 8601 UTC time string into a time_t value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> Date/time value in ISO 8601 format.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Time_t corresponding to the specified ISO string.
Note that we only allow UTC times at present.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-add-day" role="function"/>time_add_day ()</title>
<indexterm><primary>time_add_day</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_add_day (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> days);</programlisting>
<para>
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
<link linkend="time-add-day"><function>time_add_day()</function></link> to step through a certain period - if the hour gets changed
to make it valid time, any further calls to <link linkend="time-add-day"><function>time_add_day()</function></link> will also return
this hour, which may not be what you want.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>days</parameter> :</term>
<listitem><simpara> Number of days to add.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a time_t value containing <parameter>time</parameter> plus the days added.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-add-week" role="function"/>time_add_week ()</title>
<indexterm><primary>time_add_week</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_add_week (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> weeks);</programlisting>
<para>
Adds the given number of weeks to a time value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>weeks</parameter> :</term>
<listitem><simpara> Number of weeks to add.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a time_t value containing <parameter>time</parameter> plus the weeks added.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-day-begin" role="function"/>time_day_begin ()</title>
<indexterm><primary>time_day_begin</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_day_begin (<link linkend="time-t">time_t</link> t);</programlisting>
<para>
Returns the start of the day, according to the local time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>t</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the time corresponding to the beginning of the day.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-day-end" role="function"/>time_day_end ()</title>
<indexterm><primary>time_day_end</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_day_end (<link linkend="time-t">time_t</link> t);</programlisting>
<para>
Returns the end of the day, according to the local time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>t</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the time corresponding to the end of the day.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-add-day-with-zone" role="function"/>time_add_day_with_zone ()</title>
<indexterm><primary>time_add_day_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_add_day_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> days,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
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
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>days</parameter> :</term>
<listitem><simpara> Number of days to add.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a time_t value containing <parameter>time</parameter> plus the days added.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-add-week-with-zone" role="function"/>time_add_week_with_zone ()</title>
<indexterm><primary>time_add_week_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_add_week_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> weeks,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
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
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>weeks</parameter> :</term>
<listitem><simpara> Number of weeks to add.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a time_t value containing <parameter>time</parameter> plus the weeks added.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-add-month-with-zone" role="function"/>time_add_month_with_zone ()</title>
<indexterm><primary>time_add_month_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_add_month_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> months,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
Adds or subtracts a number of months to/from the given time_t value, using
the given timezone.
</para>
<para>
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.)
</para>
<para>
NOTE: this function is only here to make the transition to the timezone
functions easier. New code should use icaltimetype values and
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>months</parameter> :</term>
<listitem><simpara> Number of months to add.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a time_t value containing <parameter>time</parameter> plus the months added.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-year-begin-with-zone" role="function"/>time_year_begin_with_zone ()</title>
<indexterm><primary>time_year_begin_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_year_begin_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
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
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the beginning of the year.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-month-begin-with-zone" role="function"/>time_month_begin_with_zone ()</title>
<indexterm><primary>time_month_begin_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_month_begin_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
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
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the beginning of the month.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-week-begin-with-zone" role="function"/>time_week_begin_with_zone ()</title>
<indexterm><primary>time_week_begin_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_week_begin_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="int">int</link> week_start_day,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
Returns the start of the week containing the given time_t, using the given
timezone. week_start_day should use the same values as <link linkend="mktime"><function>mktime()</function></link>,
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
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>week_start_day</parameter> :</term>
<listitem><simpara> Day to use as the starting of the week.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the beginning of the week.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-day-begin-with-zone" role="function"/>time_day_begin_with_zone ()</title>
<indexterm><primary>time_day_begin_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_day_begin_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
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
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the beginning of the day.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-day-end-with-zone" role="function"/>time_day_end_with_zone ()</title>
<indexterm><primary>time_day_end_with_zone</primary></indexterm><programlisting><link linkend="time-t">time_t</link> time_day_end_with_zone (<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
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
<link linkend="icaltime-adjust"><function>icaltime_adjust()</function></link> to add or subtract days, hours, minutes & seconds.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time_t value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Timezone to use.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the end of the day.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="time-to-gdate-with-zone" role="function"/>time_to_gdate_with_zone ()</title>
<indexterm><primary>time_to_gdate_with_zone</primary></indexterm><programlisting><link linkend="void">void</link> time_to_gdate_with_zone (<link linkend="GDate">GDate</link> *date,
<link linkend="time-t">time_t</link> time,
<link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
<para>
Converts a time_t value to a <link linkend="GDate"><type>GDate</type></link> structure using the specified timezone.
This is analogous to <link linkend="g-date-set-time"><function>g_date_set_time()</function></link> but takes the timezone into account.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>date</parameter> :</term>
<listitem><simpara> Destination <link linkend="GDate"><type>GDate</type></link> value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> A time value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zone</parameter> :</term>
<listitem><simpara> Desired timezone for destination <parameter>date</parameter>, or NULL if the UTC timezone
is desired.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
