Libical API Documentation 4.0
Loading...
Searching...
No Matches
icalperiod.h
Go to the documentation of this file.
1/*======================================================================
2 FILE: icalperiod.h
3 CREATOR: eric 26 Jan 2001
4
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
6
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
8
9 The Original Code is eric. The Initial Developer of the Original
10 Code is Eric Busboom
11======================================================================*/
12
13#ifndef ICALPERIOD_H
14#define ICALPERIOD_H
15
20
21#include "libical_ical_export.h"
22#include "icalduration.h"
23#include "icaltime.h"
24
25#include <stdbool.h>
26
31 struct icaltimetype start;
32 struct icaltimetype end;
33 struct icaldurationtype duration;
34};
35
36#define ICALPERIODTYPE_INITIALIZER \
37 { \
38 ICALTIMETYPE_INITIALIZER, \
39 ICALTIMETYPE_INITIALIZER, \
40 ICALDURATIONTYPE_INITIALIZER}
41
73LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_from_string(const char *str);
74
99LIBICAL_ICAL_EXPORT const char *icalperiodtype_as_ical_string(struct icalperiodtype p);
100
127LIBICAL_ICAL_EXPORT char *icalperiodtype_as_ical_string_r(struct icalperiodtype p);
128
145LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);
146
162LIBICAL_ICAL_EXPORT bool icalperiodtype_is_null_period(struct icalperiodtype p);
163
178LIBICAL_ICAL_EXPORT bool icalperiodtype_is_valid_period(struct icalperiodtype p);
179
180#endif /* !ICALTIME_H */
Methods for working with durations in iCal.
const char * icalperiodtype_as_ical_string(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition icalperiod.c:84
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition icalperiod.c:93
bool icalperiodtype_is_null_period(struct icalperiodtype p)
Definition icalperiod.c:134
bool icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition icalperiod.c:144
struct icaltimetype is a pseudo-object that abstracts time handling.
A struct representing a duration.
Definition icalduration.h:29
Struct to represent a period in time.
Definition icalperiod.h:30
Definition icaltime.h:98