navigator_invoke_event_get_query_result_action()

#include <bps/navigator_invoke.h>
 

BPS_API const navigator_invoke_query_result_action_t* navigator_invoke_event_get_query_result_action(bps_event_t *event,
                                                                      int index)

Since:

BlackBerry 10.0.0

Arguments:

event

The NAVIGATOR_INVOKE_QUERY_RESULT event targeted by the query result.

index

The numerical index value of the navigator_invoke_query_result_action_t structure inside the invocation query result.

Library:

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

Description:

The navigator_invoke_event_get_query_result_action() function extracts one of the navigator_invoke_query_result_action_t structure results returned from an invocation query, identified by a given index value. The navigator_invoke_query_result_action_t action structures returned are considered viable actions based on the information supplied through the navigator_invoke_query_t structure that invoked the query. This function doesn't copy members and the returned values are released once the bps_get_event() function is called again.

Note that "ownership" of the event is not passed to the handler. For this reason, don't call the free function on invocation query result action pointers that are retrieved using this function.

Returns:

The pointer to the returned action, NULL if the query result is NULL or the index is out of bounds.