menu_sub_item_get_secondary_label()

Retrieve the secondary localized label from the sub-menu item object.

Synopsis:

#include "bps/menu.h"
 
BPS_API const char* menu_sub_item_get_secondary_label(menu_sub_item_t *item)

Since:

BlackBerry 10.0.0

Arguments:

item

The sub-menu item to retrieve the secondary label from.

Library:

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

Description:

The menu_sub_item_get_secondary_label() function extracts the secondary localized label of the given sub-menu item object. The function doesn't copy the data and the returned values are released once the bps_get_event() function is called again.

For example, the secondary label can be used to display associated account information such as "account@example.com".

Returns:

The secondary label from the sub-menu item.