navigator_invoke_recurrence_rule_create()

Create an opaque structure that represents a recurrence rule.

Synopsis:

#include <bps/navigator_invoke.h>

BPS_API int navigator_invoke_recurrence_rule_create(navigator_invoke_recurrence_rule_t **recurrence_rule,
                                                    navigator_invoke_recurrence_rule_frequency_t frequency)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule: A pointer to the new navigator_invoke_recurrence_rule_t structure to populate.

frequency: The frequency of the recurrence.

Library:

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

Description:

This function creates an instance of a navigator_invoke_recurrence_rule_t structure to use for timer registration.

Destroy each instance created by this function once they are no longer needed by calling navigator_invoke_recurrence_rule_destroy() to prevent memory leaks.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.