navigator_invoke_timer_registration_get_recurrence_rule()

Retrieve the recurrence rule from a timer registration structure.

Synopsis:

#include <bps/navigator_invoke.h>
 
BPS_API const navigator_invoke_recurrence_rule_t* navigator_invoke_timer_registration_get_recurrence_rule(const navigator_invoke_timer_registration_t *reg)

Since:

BlackBerry 10.3.1

Arguments:

reg

The navigator_invoke_timer_registration_t structure to query.

Library:

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

Description:

This function retrieves rule from the given registration structure. If the recurrence rule is not set, then NULL is returned. Note that the registration structure continues to own the returned navigator_invoke_recurrence_rule_t structure. You must not destroy the returned structure.

Returns:

A previously set navigator_invoke_recurrence_rule_t, or NULL if it was not set. errno will be set in case of failure.