navigator_invoke_recurrence_rule_set_months_of_year()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_recurrence_rule_set_months_of_year(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                                int months_of_year[],
                                                                size_t count)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule

The navigator_invoke_recurrence_rule_t structure to modify.

months_of_year

An array containing the months to be set, within the range 1 to 12, inclusive.

count

The size of the months_of_year array.

Library:

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

Description:

This function sets the months_of_year of a navigator_invoke_recurrence_rule_t structure.

Starting from the start date of the recurrence rule, the trigger will be applied at months_of_year 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 months_of_year to recurrence_rule. recurrence_rule keeps a copy of months_of_year. If applicable, months_of_year must be freed to avoid memory leaks. If you change the value of months_of_year 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.