navigator_invoke_recurrence_rule_set_start

Set the start date of a recurrence rule structure.

Synopsis:

#include <bps/navigator_invoke.h>

BPS_API int navigator_invoke_recurrence_rule_set_start_date(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                            const navigator_invoke_specific_time_t *start_date)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule: The navigator_invoke_recurrence_rule_t structure to modify.

start_date: The start date to set.

Library:

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

Description:

This function sets the start date of a navigator_invoke_recurrence_rule_t structure.

The start date is the time from which the recurrence rule can be applied.

This is a mandatory field for recurrent timers.

If either the start date or date limit field of a recurrence rule has a time-zone set, the other field must also have a time-zone set. Otherwise this function fails and returns BPS_FAILURE. The two fields do not have to be set to the same time-zone.

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

Returns: