navigator_invoke_invocation_get_action()

#include <bps/navigator_invoke.h>
 

BPS_API const char* navigator_invoke_invocation_get_action(const navigator_invoke_invocation_t *invocation)

Since:

BlackBerry 10.0.0

Arguments:

invocation

A pointer to the navigator_invoke_invocation_t structure whose action member you want to retrieve.

Library:

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

Description:

The navigator_invoke_invocation_get_action() function extracts the action member of a given navigator_invoke_invocation_t structure. The action member is used by the brokering system and invocation framework to identify what action an invoked handler is meant to perform (see the navigator_invoke_invocation_set_action() function for further details). This function doesn't copy members and the returned values are released once the navigator_invoke_invocation_t structure is destroyed with the navigator_invoke_invocation_destroy() function.

Returns:

The invocation action if one was provided by the sender, NULL otherwise.