menu_request_set_bypass_target_selection_card()

Set the bypass target selection card flag of the menu request.

Synopsis:

#include "bps/menu.h"
 
BPS_API int menu_request_set_bypass_target_selection_card(menu_request_t *request,
                                                          bool bypass_tsc)

Since:

BlackBerry 10.2.0

Arguments:

request

The menu request.

bypass_tsc

A boolean indicating whether to bypass the use of the target selection card or not. Use true to indicate that the target selection card shall be bypassed and the client will take responsibility for managing the menu.

Library:

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

Description:

The menu_request_set_bypass_target_selection_card() function sets the bypass target selection card flag of the specified menu request. The target selection card is a platform-owned card that presents the list of targets that can be selected when the user selects Share, Set, or Open menu subitems from a returned menu. By default, the flag is set to false, meaning the target selection card will be used. To bypass the use of the target selection card and to manage the menu manually, set this flag to true.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.