navigator_invoke_recurrence_rule_set_count_limit()

Set the count limit of a recurrence rule structure.

Synopsis:

#include <bps/navigator_invoke.h>
 
BPS_API int navigator_invoke_recurrence_rule_set_count_limit(navigator_invoke_recurrence_rule_t *recurrence_rule,
                                                             int count_limit)

Since:

BlackBerry 10.3.1

Arguments:

recurrence_rule

The navigator_invoke_recurrence_rule_t structure to modify.

count_limit

The count limit to set. A value of zero will reset the count limit. A negative value will cause BPS_FAILURE to be returned.

Library:

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

Description:

This function sets the count limit of a navigator_invoke_recurrence_rule_t structure.

A recurrence rule can have either a count limit or a date limit. Setting a count limit deletes any previously set date limit.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.