menu_invocation_get_uri_match()

#include "bps/menu.h"
 

BPS_API const char* menu_invocation_get_uri_match(menu_invocation_t *invocation)

Since:

BlackBerry 10.2.0

Arguments:

invocation

The menu invocation to retrieve the URI match value from.

Library:

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

Description:

The menu_invocation_get_uri_match() function extracts the URI pattern that was matched in the invocation target's target filter when the menu service queried for applicable targets for a given URI. Although the URI pattern is an attribute of a menu_invocation_t, it shall not be used to populate a navigator_invoke_invocation_t like the other menu_invocation_t parameters. The URI pattern can be used when additional information about the invocation target is needed. For example, if the application adds an option to set the target as the default target for a specific action, it might be required to provide this URI pattern in order to register the target as the default. The function doesn't copy the data and the returned values are released once the bps_get_event() function is called again.

Returns:

The URI match value inside the menu invocation, NULL if there is no URI match value.