navigator_invoke_recurrence_rule_set_interval()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_recurrence_rule_set_interval(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                          int interval)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule

The navigator_invoke_recurrence_rule_t structure to modify.

interval

The interval to set. BPS_FAILURE is returned when zero or a negative value is passed as the interval.

Library:

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

Description:

This function sets the interval of a navigator_invoke_recurrence_rule_t structure.

The interval is along with the frequency to specify a period for the recurrence rule. For instance, setting the interval to 2 and the frequency to NAVIGATOR_INVOKE_RECURRENCE_RULE_FREQUENCY_WEEKLY will produce a rule that is applied every other week.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.