ICalRecurIterator

Synopsis

#define             I_CAL_RECUR_ITERATOR_TYPE
                    ICalRecurIterator;
struct              ICalRecurIteratorClass;
ICalRecurIterator * i_cal_recur_iterator_new            (ICalRecurrenceType *rule,
                                                         ICalTimetype *dtstart);
ICalTimetype *      i_cal_recur_iterator_next           (ICalRecurIterator *iterator);
gint                i_cal_recur_iterator_set_start      (ICalRecurIterator *iterator,
                                                         ICalTimetype *start);
void                i_cal_recur_iterator_free           (ICalRecurIterator *iterator);

Description

Details

I_CAL_RECUR_ITERATOR_TYPE

#define             I_CAL_RECUR_ITERATOR_TYPE

ICalRecurIterator

typedef struct {
} ICalRecurIterator;

This is the ICalRecurIterator instance.

struct ICalRecurIteratorClass

struct ICalRecurIteratorClass {
};

This is the ICalRecurIterator class.

i_cal_recur_iterator_new ()

ICalRecurIterator * i_cal_recur_iterator_new            (ICalRecurrenceType *rule,
                                                         ICalTimetype *dtstart);

Create an ICalRecurIterator.

`rule` :	The rule applied on the ICalRecurIterator.
`dtstart` :	The start time of the recurrence.
Returns :	The newly created ICalRecurIterator. [transfer full]

Since 1.0

i_cal_recur_iterator_next ()

ICalTimetype *      i_cal_recur_iterator_next           (ICalRecurIterator *iterator);

Get the next occurrence from an iterator.

`iterator` :	The iterator.
Returns :	The next occurrence according to this recurrence rule. [transfer none]

Since 1.0

i_cal_recur_iterator_set_start ()

gint                i_cal_recur_iterator_set_start      (ICalRecurIterator *iterator,
                                                         ICalTimetype *start);

Set the date-time at which the iterator will start, where 'start' is a value between DTSTART and UNTIL. Note: CAN NOT be used with RRULEs that contain COUNT.

`iterator` :	The iterator.
`start` :	The date-time to move the iterator to.
Returns :	1 if succeeded, 0 if failed, like when the recurrence type is unsupported.

Since 3.0

i_cal_recur_iterator_free ()

void                i_cal_recur_iterator_free           (ICalRecurIterator *iterator);

Free an iterator.

iterator :

The iterator to be freed.

Since 1.0

			libical-glib Reference Manual
Top \| Description