recur_describe_recurrence
Description:
[ Version ( since = "3.30" ) ]
public string? recur_describe_recurrence (Component icalcomp, DateWeekday week_start_day, uint32 flags)
Describes some simple types of recurrences in a human-readable and localized way.
The flags
influence the output format and what to do when the icalcomp
contains more complicated recurrence, some
which the function cannot describe.
The week_start_day
is used for weekly recurrences, to start the list of selected days at that day.
Uses time_format_date_and_time to format the date/time value in the string. Call recur_describe_recurrence_ex with a custom formatting function.
Free the returned string with g_free, when no longer needed.
Parameters:
icalcomp |
an Component |
week_start_day |
a day when the week starts |
flags |
bit-or of RecurDescribeRecurrenceFlags |
Returns:
a newly allocated string, which describes the recurrence of the |