Libical API Documentation 4.0 UNRELEASED Go to the stable 3.0 documentation
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 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
12#ifndef ICALPERIOD_H
13#define ICALPERIOD_H
14
19
20#include "libical_ical_export.h"
21#include "icalduration.h"
22#include "icaltime.h"
23
24#include <stdbool.h>
25
30 struct icaltimetype start;
31 struct icaltimetype end;
32 struct icaldurationtype duration;
33};
34
35#define ICALPERIODTYPE_INITIALIZER \
36 { \
37 ICALTIMETYPE_INITIALIZER, \
38 ICALTIMETYPE_INITIALIZER, \
39 ICALDURATIONTYPE_INITIALIZER}
40
72LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_from_string(const char *str);
73
98LIBICAL_ICAL_EXPORT const char *icalperiodtype_as_ical_string(struct icalperiodtype p);
99
126LIBICAL_ICAL_EXPORT char *icalperiodtype_as_ical_string_r(struct icalperiodtype p);
127
144LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);
145
161LIBICAL_ICAL_EXPORT bool icalperiodtype_is_null_period(struct icalperiodtype p);
162
177LIBICAL_ICAL_EXPORT bool icalperiodtype_is_valid_period(struct icalperiodtype p);
178
179#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:82
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition icalperiod.c:91
bool icalperiodtype_is_null_period(struct icalperiodtype p)
Definition icalperiod.c:132
bool icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition icalperiod.c:142
struct icaltimetype is a pseudo-object that abstracts time handling.
A struct representing a duration.
Definition icalduration.h:30
Struct to represent a period in time.
Definition icalperiod.h:29
Definition icaltime.h:96