navigator_invoke_event_get_filter()

Get the filter of the get target filters invocation result.

Synopsis:

#include <bps/navigator_invoke.h>
 
BPS_API const char* navigator_invoke_event_get_filter(bps_event_t *event,
                                                      int index)

Since:

BlackBerry 10.0.0

Arguments:

event

The NAVIGATOR_INVOKE_GET_FILTERS_RESULT event.

index

The index of the filter in the filters array

Library:

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

Description:

The function doesn't copy the data and the returned value will be released once the bps_get_event() function is called again.

The navigator_invoke_event_get_filter() function should be called by the application upon receiving the NAVIGATOR_INVOKE_GET_FILTERS_RESULT event to extract the filter of the get target filters invocation.

Returns:

The filter at the index from the get target filters invocation result.