menu_event_get_item()

#include "bps/menu.h"
 

BPS_API menu_item_t* menu_event_get_item(bps_event_t *event)

Since:

BlackBerry 10.0.0

Arguments:

event

The event to extract the menu item from.

Library:

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

Description:

The menu_event_get_menu_item() function extracts the menu item from the MENU_GET_MENU_ITEMS_RESULT event. The function doesn't copy data and the returned values are released once the bps_get_event() function is called again.

Menu item ownership is not transferred to the application. An application must not call the free function on the menu item pointers that are retrieved using the menu_event_get_item() function. The pointer to the menu item is valid until the bps_get_event() function is called again.

Returns:

The menu item from the event, NULL if there is no menu item.