navigator_invoke_timer_registration_set_specific_time()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_timer_registration_set_specific_time(navigator_invoke_timer_registration_t *reg,
                                                                  const navigator_invoke_specific_time_t *specific_time)

Since:

BlackBerry 10.3.0

Arguments:

reg

The navigator_invoke_timer_registration_t structure to modify.

specific_time

The specific time to set.

Library:

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

Description:

This function sets a specific time value in a navigator_invoke_timer_registration_t structure.

This function is used to register a specific time for a headless target. If registration action is set to NAVIGATOR_INVOKE_TIMER_ACTION_UNREGISTER then the specific time will be ignored during the request.

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

This function doesn't transfer ownership of specific_time to reg. It must be freed to avoid memory leaks. This function sets reg using the value of specific_time. If you change the value of specific_time after calling this function, the updated time will not be used unless you call this function again.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.