Libical API Documentation
4.0 STABLE VERSION
[Visit the v3.0 documentation]
Toggle main menu visibility
Loading...
Searching...
No Matches
src
libical
icalduration.h
Go to the documentation of this file.
1
/*======================================================================
2
FILE: icalduration.h
3
CREATOR: eric 26 Jan 2001
4
5
SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
6
SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
7
8
The Original Code is eric. The Initial Developer of the Original
9
Code is Eric Busboom
10
======================================================================*/
11
16
17
#ifndef ICALDURATION_H
18
#define ICALDURATION_H
19
20
#include "libical_ical_export.h"
21
#include "
icaltime.h
"
22
23
#include <stdbool.h>
24
30
struct
icaldurationtype
{
31
int
is_neg
;
32
unsigned
int
days
;
33
unsigned
int
weeks
;
34
unsigned
int
hours
;
35
unsigned
int
minutes
;
36
unsigned
int
seconds
;
37
};
38
40
#define ICALDURATIONTYPE_INITIALIZER {0, 0, 0, 0, 0, 0}
42
65
LIBICAL_ICAL_EXPORT
struct
icaldurationtype
icaldurationtype_from_seconds
(int
seconds
);
66
86
LIBICAL_ICAL_EXPORT
struct
icaldurationtype
icaldurationtype_from_string
(const char *str);
87
115
LIBICAL_ICAL_EXPORT
int
icaldurationtype_as_seconds
(
struct
icaldurationtype
duration);
116
128
LIBICAL_ICAL_EXPORT
int
icaldurationtype_as_utc_seconds
(
struct
icaldurationtype
duration);
129
154
LIBICAL_ICAL_EXPORT
char
*
icaldurationtype_as_ical_string
(
struct
icaldurationtype
d);
155
176
LIBICAL_ICAL_EXPORT
char
*
icaldurationtype_as_ical_string_r
(
struct
icaldurationtype
d);
177
199
LIBICAL_ICAL_EXPORT
struct
icaldurationtype
icaldurationtype_null_duration
(void);
200
216
LIBICAL_ICAL_EXPORT
struct
icaldurationtype
icaldurationtype_bad_duration
(void);
217
234
LIBICAL_ICAL_EXPORT
bool
icaldurationtype_is_null_duration
(
struct
icaldurationtype
d);
235
252
LIBICAL_ICAL_EXPORT
bool
icaldurationtype_is_bad_duration
(
struct
icaldurationtype
d);
253
275
LIBICAL_ICAL_EXPORT
struct
icaltimetype
icalduration_extend
(struct
icaltimetype
t,
276
struct
icaldurationtype
d);
277
297
LIBICAL_ICAL_EXPORT
struct
icaldurationtype
icalduration_from_times
(struct
icaltimetype
t1,
298
struct
icaltimetype
t2);
299
314
LIBICAL_ICAL_EXPORT
struct
icaldurationtype
icaldurationtype_normalize
(struct
icaldurationtype
dur);
315
316
#endif
/* !ICALDURATION_H */
icaldurationtype_bad_duration
struct icaldurationtype icaldurationtype_bad_duration(void)
Creates a bad duration (used to indicate error).
Definition
icalduration.c:286
icalduration_from_times
struct icaldurationtype icalduration_from_times(struct icaltimetype t1, struct icaltimetype t2)
Creates a duration from two icaltimetype endpoints.
Definition
icalduration.c:349
icalduration_extend
struct icaltimetype icalduration_extend(struct icaltimetype t, struct icaldurationtype d)
Extends a time duration.
Definition
icalduration.c:300
icaldurationtype_is_bad_duration
bool icaldurationtype_is_bad_duration(struct icaldurationtype d)
Checks if a duration is a bad duration.
Definition
icalduration.c:295
icaldurationtype_from_seconds
struct icaldurationtype icaldurationtype_from_seconds(int seconds)
Creates a new icaldurationtype from a duration in seconds.
Definition
icalduration.c:28
icaldurationtype_as_seconds
int icaldurationtype_as_seconds(struct icaldurationtype dur)
Extracts the duration in integer seconds from an icaldurationtype.
Definition
icalduration.c:241
icaldurationtype_as_utc_seconds
int icaldurationtype_as_utc_seconds(struct icaldurationtype dur)
Extracts the duration in integer seconds from an icaldurationtype in UTC time.
Definition
icalduration.c:254
icaldurationtype_as_ical_string_r
char * icaldurationtype_as_ical_string_r(struct icaldurationtype d)
Definition
icalduration.c:193
icaldurationtype_from_string
struct icaldurationtype icaldurationtype_from_string(const char *str)
Creates a new icaldurationtype from a duration given as a string.
Definition
icalduration.c:43
icaldurationtype_is_null_duration
bool icaldurationtype_is_null_duration(struct icaldurationtype d)
Checks if a duration is a null duration.
Definition
icalduration.c:273
icaldurationtype_null_duration
struct icaldurationtype icaldurationtype_null_duration(void)
Creates a duration with zero length.
Definition
icalduration.c:264
icaldurationtype_as_ical_string
char * icaldurationtype_as_ical_string(struct icaldurationtype d)
Definition
icalduration.c:184
icaldurationtype_normalize
struct icaldurationtype icaldurationtype_normalize(struct icaldurationtype dur)
Create a normalized duration from another duration.
Definition
icalduration.c:372
icaltime.h
Defines the data structure for representing date-times.
icaldurationtype
Definition
icalduration.h:30
icaldurationtype::weeks
unsigned int weeks
Definition
icalduration.h:33
icaldurationtype::hours
unsigned int hours
Definition
icalduration.h:34
icaldurationtype::seconds
unsigned int seconds
Definition
icalduration.h:36
icaldurationtype::is_neg
int is_neg
Definition
icalduration.h:31
icaldurationtype::days
unsigned int days
Definition
icalduration.h:32
icaldurationtype::minutes
unsigned int minutes
Definition
icalduration.h:35
icaltimetype
Definition
icaltime.h:90
Generated on
for Libical API Documentation by
1.18.0