navigator_syskey_press_response()

Indicate whether the app handles a system key event.

Synopsis:

#include <bps/navigator.h>
 
BPS_API int navigator_syskey_press_response(const char *id,
                                            bool will_handle)

Since:

BlackBerry 10.3.1

Arguments:

id

this is the id that was returned in the @ NAVIGATOR_SYSKEY_PRESS event.

will_handle

If true, your app will handle the NAVIGATOR_SYSKEY_PRESS event. If false, your app will not handle the NAVIGATOR_SYSKEY_PRESS event.

Library:

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

Description:

This function should be called in response to receiving a NAVIGATOR_SYSKEY_PRESS event to indicate whether the app will handle that event. This should be called as soon as possible to avoid delays and performance issues.

Returns:

BPS_SUCCESS upon success. Otherwise, this function returns BPS_FAILURE.