recur_generate_instances_sync
Description:
[ Version ( since = "3.20" ) ]
public bool recur_generate_instances_sync (Component icalcomp, Time interval_start, Time interval_end, RecurInstanceCb? callback, RecurResolveTimezoneCb? get_tz_callback, Timezone default_timezone, Cancellable? cancellable = null) throws Error
Calls the given callback function for each occurrence of the event that intersects the range between the given start and end
times (the end time is not included).
Note that the occurrences may start before the given start time.
If the callback routine returns FALSE the occurrence generation stops.
The start and end times are required valid times, start before end time.
The get_tz_callback is used to resolve references to timezones. It is passed a TZID and should return the ICalTimezone *
corresponding to that TZID. We need to do this as we access timezones in different ways on the client & server.
The default_timezone argument is used for DTSTART or DTEND properties that are DATE values or do not have a TZID (i.e. floating times).
Parameters:
| icalcomp |
an Component |
| interval_start |
an interval start, for which generate instances |
| interval_end |
an interval end, for which generate instances |
| callback |
a callback to be called for each instance |
| get_tz_callback |
a callback to call when resolving timezone |
| default_timezone |
a default Timezone |
| cancellable |
a Cancellable; can be null |
| callback_user_data |
user data for |
| get_tz_callback_user_data |
user data for |
Returns:
|
true if successful (when all instances had been returned), false otherwise. |