navigator_invoke_recurrence_rule_set_hours_of_day()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_recurrence_rule_set_hours_of_day(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                              int hours_of_day[],
                                                              size_t count)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule

The navigator_invoke_recurrence_rule_t structure to modify.

hours_of_day

An array containing the hours to be set, within the range 0 to 23, inclusive.

count

The size of the hours_of_day array.

Library:

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

Description:

This function sets the hours_of_day of a navigator_invoke_recurrence_rule_t structure.

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