Libical API Documentation 3.0

icalperiod.h
Go to the documentation of this file.
1/*======================================================================
2 FILE: icalperiod.h
3 CREATOR: eric 26 Jan 2001
4
5 (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
6
7 This library is free software; you can redistribute it and/or modify
8 it under the terms of either:
9
10 The LGPL as published by the Free Software Foundation, version
11 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
12
13 Or:
14
15 The Mozilla Public License Version 2.0. You may obtain a copy of
16 the License at https://www.mozilla.org/MPL/
17
18 The Original Code is eric. The Initial Developer of the Original
19 Code is Eric Busboom
20======================================================================*/
21
22#ifndef ICALPERIOD_H
23#define ICALPERIOD_H
24
30#include "libical_ical_export.h"
31#include "icalduration.h"
32#include "icaltime.h"
33
37 struct icalperiodtype
38{
39 struct icaltimetype start;
40 struct icaltimetype end;
41 struct icaldurationtype duration;
42};
43
75LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_from_string(const char *str);
76
101LIBICAL_ICAL_EXPORT const char *icalperiodtype_as_ical_string(struct icalperiodtype p);
102
129LIBICAL_ICAL_EXPORT char *icalperiodtype_as_ical_string_r(struct icalperiodtype p);
130
147LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);
148
164LIBICAL_ICAL_EXPORT int icalperiodtype_is_null_period(struct icalperiodtype p);
165
180LIBICAL_ICAL_EXPORT int icalperiodtype_is_valid_period(struct icalperiodtype p);
181
182#endif /* !ICALTIME_H */
icalduration.h
Methods for working with durations in iCal.
icalperiodtype_as_ical_string
const char * icalperiodtype_as_ical_string(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:94
icalperiodtype_as_ical_string_r
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:103
icalperiodtype_null_period
struct icalperiodtype icalperiodtype_null_period(void)
Definition: icalperiod.c:133
icalperiodtype_from_string
struct icalperiodtype icalperiodtype_from_string(const char *str)
Constructs a new icalperiodtype from str.
Definition: icalperiod.c:30
icalperiodtype_is_null_period
int icalperiodtype_is_null_period(struct icalperiodtype p)
Definition: icalperiod.c:144
icalperiodtype_is_valid_period
int icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition: icalperiod.c:154
icaltime.h
struct icaltimetype is a pseudo-object that abstracts time handling.
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
icaltimetype
Definition: icaltime.h:105