Libical API Documentation 3.0
|
Functions for working with iCal periods (of time). More...
Go to the source code of this file.
Data Structures | |
struct | icalperiodtype |
Struct to represent a period in time. More... | |
Functions | |
const char * | icalperiodtype_as_ical_string (struct icalperiodtype p) |
Converts an icalperiodtype into an iCal-formatted string. More... | |
char * | icalperiodtype_as_ical_string_r (struct icalperiodtype p) |
Converts an icalperiodtype into an iCal-formatted string. More... | |
struct icalperiodtype | icalperiodtype_from_string (const char *str) |
Constructs a new icalperiodtype from str. More... | |
int | icalperiodtype_is_null_period (struct icalperiodtype p) |
int | icalperiodtype_is_valid_period (struct icalperiodtype p) |
struct icalperiodtype | icalperiodtype_null_period (void) |
Functions for working with iCal periods (of time).
const char * icalperiodtype_as_ical_string | ( | struct icalperiodtype | p | ) |
Converts an icalperiodtype into an iCal-formatted string.
p | The time period to convert |
free()
by the caller.char * icalperiodtype_as_ical_string_r | ( | struct icalperiodtype | p | ) |
Converts an icalperiodtype into an iCal-formatted string.
p | The time period to convert |
struct icalperiodtype icalperiodtype_from_string | ( | const char * | str | ) |
Constructs a new icalperiodtype from str.
str | The string from which to construct a time period |
There are two ways to specify a duration; either a start time and an end time can be specified, or a start time and a duration. The format for there is as such:
<STARTTIME>/<ENDTIME>
<STARTTIME>/<DURATION>
The format for the times is the same as those used by icaltime_from_string(), and the format for the duration is the same as that used by icaldurationtype_from_string().
int icalperiodtype_is_null_period | ( | struct icalperiodtype | p | ) |
Checks if a given icalperiodtype is a null period.
p | The time period to check |
int icalperiodtype_is_valid_period | ( | struct icalperiodtype | p | ) |
Checks if a given icalperiodtype is a valid period.
p | The time period to check |
struct icalperiodtype icalperiodtype_null_period | ( | void | ) |
Creates a null period icalperiodtype.