icalrecurrencetype Struct Reference

Data Fields
icalrecurrence_by_data	by [ICAL_BY_NUM_PARTS]
int	count
icalrecurrencetype_frequency	freq
short	interval
int	refcount
char *	rscale
icalrecurrencetype_skip	skip
struct icaltimetype	until
icalrecurrencetype_weekday	week_start

Detailed Description

Recurrence type routines Data structure for holding digested recurrence rules.

Note

::until and ::count are mutually exclusive.

Definition at line 250 of file icalrecur.h.

Field Documentation

icalrecurrence_by_data icalrecurrencetype::by[ICAL_BY_NUM_PARTS]

Encoded value

The 'day' element of the ICAL_BY_DAY array is encoded to allow representation of both the day of the week ( Monday, Tuesday), but also the Nth day of the week (first Tuesday of the month, last Thursday of the year).

These values are decoded by icalrecurrencetype_day_day_of_week() and icalrecurrencetype_day_position().

The 'month' element of the ICAL_BY_MONTH array is encoded to allow representation of the "L" leap suffix (RFC 7529).

These values are decoded by icalrecurrencetype_month_is_leap() and icalrecurrencetype_month_month().

Definition at line 286 of file icalrecur.h.

int icalrecurrencetype::count

number of times to recur, mutually exclusive with ::until

Definition at line 261 of file icalrecur.h.

icalrecurrencetype_frequency icalrecurrencetype::freq

the frequency of the recurrence

Definition at line 255 of file icalrecur.h.

short icalrecurrencetype::interval

interval between recurrences

Definition at line 264 of file icalrecur.h.

int icalrecurrencetype::refcount

Reference count

Definition at line 252 of file icalrecur.h.

char* icalrecurrencetype::rscale

For RSCALE extension (RFC 7529)

Definition at line 289 of file icalrecur.h.

icalrecurrencetype_skip icalrecurrencetype::skip

recurrence skip (forward, backward, omit)

Definition at line 292 of file icalrecur.h.

struct icaltimetype icalrecurrencetype::until

recur until this date-time, mutually exclusive with ::count

Definition at line 258 of file icalrecur.h.

icalrecurrencetype_weekday icalrecurrencetype::week_start

week day start, for weekday recurrences

Definition at line 267 of file icalrecur.h.