navigator_invoke_recurrence_rule_set_date

Set the date limit of a recurrence rule structure.

Synopsis:

#include <bps/navigator_invoke.h>

BPS_API int navigator_invoke_recurrence_rule_set_date_limit(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                            const navigator_invoke_specific_time_t *date_limit)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule: The navigator_invoke_recurrence_rule_t structure to modify.

date_limit: The date limit to set. A NULL value will reset the date limit.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

This function sets the date limit of a navigator_invoke_recurrence_rule_t structure.

The date limit is the time at which the recurrence rule will no longer be applied. A recurrence rule can have either a count limit or a date limit. Setting a date limit deletes any previously set count limit.

If either the start date or date limit field of a recurrence rule has a time-zone set, the other field must also have a time-zone set. Otherwise this function fails and returns BPS_FAILURE. The two fields do not have to be set to the same time-zone.

This function doesn't transfer ownership of date_limit to recurrence_rule. A copy of date_limit is kept by recurrence_rule. date_limit must be freed to avoid memory leaks. If you change the value of date_limit after calling this function, the updated time will not be used unless you call this function again.

Returns: