navigator_invoke_recurrence_rule_get_hours_of_day()

Retrieve the hours in a day that an event should occur.

Synopsis:

#include <bps/navigator_invoke.h>
 
BPS_API const int* navigator_invoke_recurrence_rule_get_hours_of_day(const navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                                     int *count)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule

The navigator_invoke_recurrence_rule_t structure to query.

count

The number of items returned upon success, BPS_FAILURE with errno set otherwise.

Library:

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

Description:

This function retrieves the hours of the day from the given navigator_invoke_recurrence_rule_t.

The recurrence rule structure continues to own the returned array. You must not modify or destroy the returned array.

Returns:

The hours in a day set for the recurrence rule.