navigator_invoke_timer_registration_set_recurrence_rule()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_timer_registration_set_recurrence_rule(navigator_invoke_timer_registration_t *reg,
                                                                    const navigator_invoke_recurrence_rule_t *rule)

Since:

BlackBerry 10.3.1

Arguments:

reg

The navigator_invoke_timer_registration_t structure to modify.

rule

A valid navigator_invoke_recurrence_rule_t structure to set.

Library:

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

Description:

The navigator_invoke_timer_registration_set_recurrence_rule() function stores rule in the given registration structure. This function is used to register or re-register a recurrent rule for a headless target.

If registration action is set to NAVIGATOR_INVOKE_TIMER_ACTION_UNREGISTER, then the rule will be ignored during the request.

A timer registration can have either a specific time or a recurrence rule. Setting a recurrence rule deletes any previously set specific time.

Valid recurrence rules must have a start date set.

This function doesn't transfer ownership of the rule to reg. It must be freed to avoid memory leaks. Any modifications to the rule after the navigator_invoke_timer_registration_set_recurrence_rule() function was called will not be reflected in the registration structure. Call this function only after the rule has been formed.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.