navigator_invoke_recurrence_rule_set_days_of_month()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_recurrence_rule_set_days_of_month(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                               int days_of_month[],
                                                               size_t count)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule

The navigator_invoke_recurrence_rule_t structure to modify.

days_of_month

An array containing the days to be set, within the range 1 to 31, inclusive.

count

The size of the days_of_month array.

Library:

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

Description:

This function sets the days_of_month 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_month per the frequency of the recurrence rule, as allowed by other recurrence conditions, until the count limit or date limit are reached, if applicable.

Using this recurrence condition with NAVIGATOR_INVOKE_RECURRENCE_RULE_FREQUENCY_WEEKLY frequency will fail.

This function doesn't transfer ownership of days_of_month to recurrence_rule. recurrence_rule keeps a copy of days_of_month. If applicable, days_of_month must be freed to avoid memory leaks. If you change the value of days_of_month 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.