recur_describe_recurrence_ex

Description:

[ Version ( since = "3.38" ) ]
public string? recur_describe_recurrence_ex (Component icalcomp, DateWeekday week_start_day, uint32 flags, RecurFormatDateTimeFunc? datetime_fmt_func)

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.

If datetime_fmt_func is null, the time_format_date_and_time is used to format data/time value.

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
datetime_fmt_func	formatting function for date/time value

Returns:

a newly allocated string, which describes the recurrence of the icalcomp, or NULL, when the icalcomp doesn't recur or the recurrence is too complicated to describe, also according to given flags.

Namespace: ECal

Package: libecal-2.0