navigator_invoke_recurrence_rule_set_days_of_week()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_recurrence_rule_set_days_of_week(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                              int days_of_week[],
                                                              size_t count)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule

The navigator_invoke_recurrence_rule_t structure to modify.

days_of_week

An array containing the days to be set, within the range 1 (Sunday) to 7 (Saturday), inclusive.

count

The size of the days_of_week array.

Library:

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

Description:

This function sets the days_of_week of a navigator_invoke_recurrence_rule_t structure.

Starting from the start date of the recurrence rule, the trigger will be applied at days_of_week per the frequency of the recurrence rule, as allowed by other recurrence conditions, until the count limit or date limit are reached, if applicable.

This function doesn't transfer ownership of days_of_week to recurrence_rule. recurrence_rule keeps a copy of days_of_week. If applicable, days_of_week must be freed to avoid memory leaks. If you change the value of days_of_week calling this function, you must call this function again to use the new value.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.