menu_item_get_secondary

Retrieve the secondary title from the menu item object.

Synopsis:

#include "bps/menu.h"

BPS_API const char* menu_item_get_secondary_title(menu_item_t *item)

Since:

BlackBerry 10.0.0

Arguments:

item: The menu item to retrieve the secondary title from.

Library:

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

Description:

The menu_item_get_secondary_title() function extracts the secondary title of the given menu item object. The secondary title may be presented as a subscript to the main title. The function doesn't copy the data and the returned values are released once the bps_get_event() function is called again.

Returns:

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